Dbus methods isMember and isAdmin

create isAdmin method in parallel with isMember
extend both to have the ability to add or remove members or admins

update documentation
This commit is contained in:
John Freed 2021-08-19 11:19:08 +02:00
parent 217afd74c4
commit 0691a91dad
3 changed files with 185 additions and 13 deletions

View file

@ -108,14 +108,6 @@ Note that quitting a group will not remove the group from the getGroupIds comman
Exceptions: GroupNotFound, Failure
isMember(groupId<ay>) -> active<b>::
isMember(base64GroupId<s>) -> active<b>::
* groupId : Byte array representing the internal group identifier
* base64GroupId : String representing the internal group identifier in Base64 format
* active : Boolean representing whether you are a member of the group
Exceptions: GroupNotFound
sendEndSessionMessage(recipients<as>) -> <>::
* recipients : String array of phone numbers
@ -266,6 +258,32 @@ base64GroupId : String representing the internal group identifier in Base64 form
Exception: Failure if base64GroupId or groupId is malformed; GroupNotFound
isMember(groupId<ay>) -> active<b>::
isMember(base64GroupId<s>) -> active<b>::
isMember(groupId<ay>, members<as>, setMemberStatus<b>) -> memberList<as>::
isMember(base64GroupId<s>, members<as>, setMemberStatus<b>) -> memberList<as>::
* groupId : Byte array representing the internal group identifier
* base64GroupId : String representing the internal group identifier in Base64 format
* members : Phone numbers of users to add to or remove from group
* setMemberStatus : true for add to group members; false for remove from group members
* active : Boolean representing whether you are a member of the group
* memberList : List of members after command execution
Exceptions: GroupNotFound, Failure
isAdmin(groupId<ay>) -> admin<b>::
isAdmin(base64GroupId<s>) -> admin<b>::
isAdmin(groupId<ay>, admins<as>, setAdminStatus<b>) -> adminList<as>::
isAdmin(base64GroupId<s>, admins<as>, setAdminStatus<b>) -> adminList<as>::
* groupId : Byte array representing the internal group identifier
* base64GroupId : String representing the internal group identifier in Base64 format
* admins : Phone numbers of users to grant or deny admin status
* setAdminStatus : true for add to group admins; false for remove from group admins
* admin : Boolean representing whether you are an admin of the group
* adminList : List of admins after command execution
Exceptions: GroupNotFound, Failure
getGroupMembers(groupId<ay>) -> members<as>::
getGroupMembers(base64GroupId<s>) -> members<as>::
* members : String array with the phone numbers of all active members of a group