com.ciscospark.androidsdk.people

Interface PersonClient

public interface PersonClient

A client wrapper of the Cisco Spark People REST API

Since:

0.1

Method Summary

Modifier and Type	Method and Description
void	create(java.lang.String email, java.lang.String displayName, java.lang.String firstName, java.lang.String lastName, java.lang.String avatar, java.lang.String orgId, java.lang.String roles, java.lang.String licenses, CompletionHandler<Person> handler) Create people in the authenticated user's organization.
void	delete(java.lang.String personId, CompletionHandler<java.lang.Void> handler) Delete the details of person by person id.
void	get(java.lang.String personId, CompletionHandler<Person> handler) Retrieves the details for a person by person id.
void	getMe(CompletionHandler<Person> handler) Retrieves the details for the authenticated user.
void	list(java.lang.String email, java.lang.String displayName, int max, CompletionHandler<java.util.List<Person>> handler) Lists people in the authenticated user's organization.
void	update(java.lang.String personId, java.lang.String email, java.lang.String displayName, java.lang.String firstName, java.lang.String lastName, java.lang.String avatar, java.lang.String orgId, java.lang.String roles, java.lang.String licenses, CompletionHandler<Person> handler) Update people in the authenticated user's organization.

Method Detail

list

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

Lists people in the authenticated user's organization.

Parameters:

email - If not nil, only list people with this email address.

displayName - If not nil, only list people whose name starts with this string.

max - The maximum number of people in the response.

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

Since:

0.1

get

void get(@NonNull
         java.lang.String personId,
         @NonNull
         CompletionHandler<Person> handler)

Retrieves the details for a person by person id.

Parameters:

personId - The identifier of the person.

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

Since:

0.1

getMe

void getMe(@NonNull
           CompletionHandler<Person> handler)

Retrieves the details for the authenticated user.

Parameters:

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

Since:

0.1

create

void create(@NonNull
            java.lang.String email,
            @Nullable
            java.lang.String displayName,
            @Nullable
            java.lang.String firstName,
            @Nullable
            java.lang.String lastName,
            @Nullable
            java.lang.String avatar,
            @Nullable
            java.lang.String orgId,
            @Nullable
            java.lang.String roles,
            @Nullable
            java.lang.String licenses,
            @NonNull
            CompletionHandler<Person> handler)

Create people in the authenticated user's organization. Only admins are able to use this function

Parameters:

email - Email address of the person.

displayName - Full name of the person.

firstName - firstName name of the person.

lastName - lastName firstName name of the person.

avatar - URL to the person's avatar in PNG format.

orgId - ID of the organization to which this person belongs.

roles - Roles of the person.

licenses - Licenses allocated to the person.

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

Since:

1.4

update

void update(@NonNull
            java.lang.String personId,
            @Nullable
            java.lang.String email,
            @Nullable
            java.lang.String displayName,
            @Nullable
            java.lang.String firstName,
            @Nullable
            java.lang.String lastName,
            @Nullable
            java.lang.String avatar,
            @Nullable
            java.lang.String orgId,
            @Nullable
            java.lang.String roles,
            @Nullable
            java.lang.String licenses,
            @NonNull
            CompletionHandler<Person> handler)

Update people in the authenticated user's organization. Only admins are able to use this function

Parameters:

personId - The identifier of the person.

email - Email address of the person.

displayName - Full name of the person.

firstName - firstName name of the person.

lastName - lastName firstName name of the person.

avatar - URL to the person's avatar in PNG format.

orgId - ID of the organization to which this person belongs.

roles - Roles of the person.

licenses - Licenses allocated to the person.

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

Since:

1.4

delete

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

Delete the details of person by person id. Only admins are able to use this function

Parameters:

personId - The identifier of the person.

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

Since:

1.4