com.ciscospark.androidsdk.team

Interface TeamMembershipClient

public interface TeamMembershipClient

A client wrapper of the Cisco Spark TeamMemberships REST API

Since:

0.1

Method Summary

Modifier and Type	Method and Description
void	create(java.lang.String teamId, java.lang.String personId, java.lang.String personEmail, boolean isModerator, CompletionHandler<TeamMembership> handler) Adds a person to a team by person id; optionally making the person a moderator of the team.
void	delete(java.lang.String membershipId, CompletionHandler<java.lang.Void> handler) Deletes a membership by id.
void	get(java.lang.String membershipId, CompletionHandler<TeamMembership> handler) Retrieves the details for a membership by id.
void	list(java.lang.String teamId, int max, CompletionHandler<java.util.List<TeamMembership>> handler) Lists all team memberships where the authenticated user belongs.
void	update(java.lang.String membershipId, boolean isModerator, CompletionHandler<TeamMembership> handler) Updates the details for a membership by id.

Method Detail

list

void list(@Nullable
          java.lang.String teamId,
          int max,
          @NonNull
          CompletionHandler<java.util.List<TeamMembership>> handler)

Lists all team memberships where the authenticated user belongs.

Parameters:

teamId - Limit results to a specific team, by ID.

max - The maximum number of team memberships in the response.

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

Since:

0.1

create

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

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

Parameters:

teamId - The identifier of the team.

personId - The identifier of the person.

personEmail - The email of the person.

isModerator - If true, make the person a moderator of the team. 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<TeamMembership> handler)

Retrieves the details for a membership by 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<TeamMembership> handler)

Updates the details for a membership by id.

Parameters:

membershipId - The identifier of the membership.

isModerator - If true, make the person a moderator of the team. 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 id.

Parameters:

membershipId - The identifier of the membership.

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

Since:

0.1