Top |
MatrixEventRoomThirdPartyInviteMatrixEventRoomThirdPartyInvite — Class to hold a m.room.third_party_invite event |
Acts as an m.room.member invite event, where there isn't a target user_id to invite. This event contains a token and a public key whose private key must be used to sign the token. Any user who can present that signature may use this invitation to join the target room.
#define MATRIX_EVENT_TYPE_ROOM_THIRD_PARTY_INVITE (matrix_event_room_third_party_invite_get_type ())
The type for MatrixEventRoomThirdPartyInvite.
MatrixEventRoomThirdPartyInvite *
matrix_event_room_third_party_invite_new
(void
);
const gchar *
matrix_event_room_third_party_invite_get_display_name
(MatrixEventRoomThirdPartyInvite *self
);
Get and return the current value of the "display-name" property.
A user-readable string which represents the user who has been invited. This should not contain the user's third party ID, as otherwise when the invite is accepted it would leak the association between the matrix ID and the third party ID.
void matrix_event_room_third_party_invite_set_display_name (MatrixEventRoomThirdPartyInvite *self
,const gchar *value
);
Set the value of the "display-name" property to value
.
A user-readable string which represents the user who has been invited. This should not contain the user's third party ID, as otherwise when the invite is accepted it would leak the association between the matrix ID and the third party ID.
self |
the MatrixEventRoomThirdPartyInvite instance to modify |
|
value |
the new value of the "display-name" property |
const gchar *
matrix_event_room_third_party_invite_get_key_validity_url
(MatrixEventRoomThirdPartyInvite *self
);
Get and return the current value of the "key-validity-url" property.
A URL which can be fetched, with querystring public_key=public_key, to validate whether the key has been revoked. The URL must return a JSON object containing a boolean property named valid.
void matrix_event_room_third_party_invite_set_key_validity_url (MatrixEventRoomThirdPartyInvite *self
,const gchar *value
);
Set the value of the "key-validity-url" property to value
.
A URL which can be fetched, with querystring public_key=public_key, to validate whether the key has been revoked. The URL must return a JSON object containing a boolean property named valid.
self |
the MatrixEventRoomThirdPartyInvite instance to modify |
|
value |
the new value of the "key-validity-url" property |
const gchar *
matrix_event_room_third_party_invite_get_public_key
(MatrixEventRoomThirdPartyInvite *self
);
Get and return the current value of the "public-key" property.
A base64-encoded ed25519 key with which token must be signed (though a signature from any entry in public_keys is also sufficient). This exists for backwards compatibility.
void matrix_event_room_third_party_invite_set_public_key (MatrixEventRoomThirdPartyInvite *self
,const gchar *value
);
Set the value of the "public-key" property to value
.
A base64-encoded ed25519 key with which token must be signed (though a signature from any entry in public_keys is also sufficient). This exists for backwards compatibility.
self |
the MatrixEventRoomThirdPartyInvite instance to modify |
|
value |
the new value of the "public-key" property |
MatrixEventRoomThirdPartyInvitePublicKey * matrix_event_room_third_party_invite_get_public_keys (MatrixEventRoomThirdPartyInvite *self
,int *result_length1
);
Get and return the current value of the "public-keys" property.
Keys with which the token may be signed.
void matrix_event_room_third_party_invite_set_public_keys (MatrixEventRoomThirdPartyInvite *self
,MatrixEventRoomThirdPartyInvitePublicKey *value
,int value_length1
);
Set the value of the "public-keys" property to value
.
Keys with which the token may be signed.
self |
the MatrixEventRoomThirdPartyInvite instance to modify |
|
value |
the new value of the "public-keys" property |
const gchar *
matrix_event_room_third_party_invite_get_token
(MatrixEventRoomThirdPartyInvite *self
);
Get and return the current value of the "token" property.
The token, of which a signature must be produced in order to join the room.
void matrix_event_room_third_party_invite_set_token (MatrixEventRoomThirdPartyInvite *self
,const gchar *value
);
Set the value of the "token" property to value
.
The token, of which a signature must be produced in order to join the room.
self |
the MatrixEventRoomThirdPartyInvite instance to modify |
|
value |
the new value of the "token" property |
MatrixEventRoomThirdPartyInvitePublicKey *
matrix_event_room_third_party_invite_public_key_dup
(const MatrixEventRoomThirdPartyInvitePublicKey *self
);
Creates a copy of self.
See also: matrix_event_room_third_party_invite_public_key_copy()
, matrix_event_room_third_party_invite_public_key_destroy()
, matrix_event_room_third_party_invite_public_key_free()
void
matrix_event_room_third_party_invite_public_key_free
(MatrixEventRoomThirdPartyInvitePublicKey *self
);
Frees the heap-allocated struct.
See also: matrix_event_room_third_party_invite_public_key_dup()
, matrix_event_room_third_party_invite_public_key_copy()
, matrix_event_room_third_party_invite_public_key_destroy()
void matrix_event_room_third_party_invite_public_key_copy (const MatrixEventRoomThirdPartyInvitePublicKey *self
,MatrixEventRoomThirdPartyInvitePublicKey *dest
);
Creates a copy of self.
See also: matrix_event_room_third_party_invite_public_key_dup()
, matrix_event_room_third_party_invite_public_key_destroy()
, matrix_event_room_third_party_invite_public_key_free()
self |
the struct to copy |
|
dest |
a unused struct. Use |
void
matrix_event_room_third_party_invite_public_key_destroy
(MatrixEventRoomThirdPartyInvitePublicKey *self
);
Frees the content of the struct pointed by self
.
See also: matrix_event_room_third_party_invite_public_key_dup()
, matrix_event_room_third_party_invite_public_key_copy()
, matrix_event_room_third_party_invite_public_key_free()
struct MatrixEventRoomThirdPartyInvitePublicKey { gchar* key; gchar* validity_url; };
struct MatrixEventRoomThirdPartyInvite { MatrixEventState parent_instance; MatrixEventRoomThirdPartyInvitePrivate * priv; };
Class to hold a m.room.third_party_invite event
Acts as an m.room.member invite event, where there isn't a target user_id to invite. This event contains a token and a public key whose private key must be used to sign the token. Any user who can present that signature may use this invitation to join the target room.
struct MatrixEventRoomThirdPartyInviteClass { MatrixEventStateClass parent_class; };
The class structure for MATRIX_EVENT_TYPE_ROOM_THIRD_PARTY_INVITE
. All the fields in this structure are private and should never be accessed directly.