com.ciscospark.androidsdk.membership

Interface MembershipClient

public interface MembershipClient

A client wrapper of the Cisco Spark Room Memberships REST API

Since:

0.1

Method Summary

Modifier and Type	Method and Description
void	create(java.lang.String roomId, java.lang.String personId, java.lang.String personEmail, boolean isModerator, CompletionHandler<Membership> handler) Adds a person to a room 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 roomId, java.lang.String personId, java.lang.String personEmail, int max, CompletionHandler<java.util.List<Membership>> handler) Lists all room memberships where the authenticated user belongs.
void	update(java.lang.String membershipId, boolean isModerator, CompletionHandler<Membership> handler) Updates the properties of a membership by membership id.

Method Detail

list

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

Lists all room memberships where the authenticated user belongs.

Parameters:

roomId - The identifier of the room 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 roomId,
            @Nullable
            java.lang.String personId,
            @Nullable
            java.lang.String personEmail,
            boolean isModerator,
            @NonNull
            CompletionHandler<Membership> handler)

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

Parameters:

roomId - The identifier of the room 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 room. 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 room 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 room 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