com.ciscowebex.androidsdk.membership

Interface MembershipClient

public interface MembershipClient

A client wrapper of the Cisco Webex Space Memberships REST API

Since:

0.1

Method Summary

Modifier and Type	Method and Description
void	create(java.lang.String spaceId, java.lang.String personId, java.lang.String personEmail, boolean isModerator, CompletionHandler<Membership> handler) Adds a person to a space by person id; optionally making the person a moderator.
void	delete(java.lang.String membershipId, CompletionHandler<java.lang.Void> handler) Deletes a membership by membership id.
void	get(java.lang.String membershipId, CompletionHandler<Membership> handler) Retrieves the details for a membership by membership id.
void	list(java.lang.String spaceId, java.lang.String personId, java.lang.String personEmail, int max, CompletionHandler<java.util.List<Membership>> handler) Lists all space memberships where the authenticated user belongs.
void	listWithReadStatus(java.lang.String spaceId, CompletionHandler<java.util.List<MembershipReadStatus>> handler) Returns a list of memberships with details about the lastSeenId for each user so that application can tell which message was the last message was read by each user.
void	setMembershipObserver(MembershipObserver observer) Sets a MembershipObserver in this client.
void	update(java.lang.String membershipId, boolean isModerator, CompletionHandler<Membership> handler) Updates the properties of a membership by membership id.

Method Detail

setMembershipObserver

void setMembershipObserver(MembershipObserver observer)

Sets a MembershipObserver in this client.

Parameters:

observer - the callback to receive events about membership changes.

Since:

2.3.0

See Also:

MembershipObserver

list

void list(@Nullable
          java.lang.String spaceId,
          @Nullable
          java.lang.String personId,
          @Nullable
          java.lang.String personEmail,
          int max,
          @NonNull
          CompletionHandler<java.util.List<Membership>> handler)

Lists all space memberships where the authenticated user belongs.

Parameters:

spaceId - The identifier of the space where the membership belongs.

personId - The identifier of the person who has the memberships.

personEmail - The email address of the person who has the memberships.

max - The maximum number of items in the response.

handler - A closure to be executed once the request has finished.

Since:

0.1

create

void create(@NonNull
            java.lang.String spaceId,
            @Nullable
            java.lang.String personId,
            @Nullable
            java.lang.String personEmail,
            boolean isModerator,
            @NonNull
            CompletionHandler<Membership> handler)

Adds a person to a space by person id; optionally making the person a moderator.

Parameters:

spaceId - The identifier of the space where the person is to be added.

personId - The identifier of the person to be added.

personEmail - The email address of the person to be added.

isModerator - If true, make the person a moderator of the space. The default is false.

handler - A closure to be executed once the request has finished.

Since:

0.1

get

void get(@NonNull
         java.lang.String membershipId,
         @NonNull
         CompletionHandler<Membership> handler)

Retrieves the details for a membership by membership id.

Parameters:

membershipId - The identifier of the membership.

handler - A closure to be executed once the request has finished.

Since:

0.1

update

void update(@NonNull
            java.lang.String membershipId,
            boolean isModerator,
            @NonNull
            CompletionHandler<Membership> handler)

Updates the properties of a membership by membership id.

Parameters:

membershipId - The identifier of the membership.

isModerator - If true, make the person a moderator of the space in this membership. The default is false.

handler - A closure to be executed once the request has finished.

Since:

0.1

delete

void delete(@NonNull
            java.lang.String membershipId,
            @NonNull
            CompletionHandler<java.lang.Void> handler)

Deletes a membership by membership id. It removes the person from the space where the membership belongs.

Parameters:

membershipId - The identifier of the membership.

handler - A closure to be executed once the request has finished.

Since:

0.1

listWithReadStatus

void listWithReadStatus(@NonNull
                        java.lang.String spaceId,
                        @NonNull
                        CompletionHandler<java.util.List<MembershipReadStatus>> handler)

Returns a list of memberships with details about the lastSeenId for each user so that application can tell which message was the last message was read by each user.

Parameters:

spaceId - The identifier of the space.

handler - A closure to be executed once the request has finished.

Since:

2.3.0

See Also:

MembershipReadStatus