Loading...
Searching...
No Matches
GroupMembership Interface Reference
Inheritance diagram for GroupMembership:
Managed

Public Member Functions

proto external GroupData GetGroup ()
 Returns group of the membership.
 
proto external int GetId ()
 Returns membership ID.
 
proto external string GetNickname ()
 Returns nickname of the member.
 
proto external int CreatedAt ()
 Returns time when the membership was created.
 
proto external GroupMemberRole GetRole ()
 Returns Role of this member.
 
proto external void RequestDetails (notnull BackendCallback pCallback)
 Fetch details of this membership from backend.
 
proto external void Kick (notnull BackendCallback pCallback)
 Kick the member from the Group. Marks the membership as no longer valid.
 
proto external void UpdateRole (notnull BackendCallback pCallback, int iRoleId)
 Update member's role to a new one.
 
- Public Member Functions inherited from Managed
proto external ref Managed Clone ()
 Return shallow copy of object, or null if it is not allowed (not public constructor)
 

Member Function Documentation

◆ CreatedAt()

proto external int GroupMembership.CreatedAt ( )

Returns time when the membership was created.

◆ GetGroup()

proto external GroupData GroupMembership.GetGroup ( )

Returns group of the membership.

◆ GetId()

proto external int GroupMembership.GetId ( )

Returns membership ID.

◆ GetNickname()

proto external string GroupMembership.GetNickname ( )

Returns nickname of the member.

◆ GetRole()

proto external GroupMemberRole GroupMembership.GetRole ( )

Returns Role of this member.

◆ Kick()

proto external void GroupMembership.Kick ( notnull BackendCallback pCallback)

Kick the member from the Group. Marks the membership as no longer valid.

◆ RequestDetails()

proto external void GroupMembership.RequestDetails ( notnull BackendCallback pCallback)

Fetch details of this membership from backend.

◆ UpdateRole()

proto external void GroupMembership.UpdateRole ( notnull BackendCallback pCallback,
int iRoleId )

Update member's role to a new one.

Note
The user updating cannot promote other user to a role with higher priority than their own role and must have sufficient permissions to do so.
Parameters
pCallbackScript callback where you will receive the result
iRoleIdID of the new role

The documentation for this interface was generated from the following file: