com.ciscowebex.androidsdk.space

Interface SpaceClient

public interface SpaceClient

A client wrapper of the Cisco Webex Spaces REST API

Since:

0.1

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	SpaceClient.SortBy Sort results by space ID (id), most recent activity (lastactivity), or most recently created (created).

Method Summary

Modifier and Type	Method and Description
void	create(java.lang.String title, java.lang.String teamId, CompletionHandler<Space> handler) Creates a space.
void	delete(java.lang.String spaceId, CompletionHandler<java.lang.Void> handler) Deletes a space by id.
void	get(java.lang.String spaceId, CompletionHandler<Space> handler) Retrieves the details for a space by id.
void	getMeetingInfo(java.lang.String spaceId, CompletionHandler<SpaceMeetingInfo> handler) Shows Webex meeting details for a space such as the SIP address, meeting URL, toll-free and toll dial-in numbers.
void	getWithReadStatus(java.lang.String spaceId, CompletionHandler<SpaceReadStatus> handler) Returns a SpaceReadStatus with the details about the date of the last activity in the space, and the date of current user last presence in the space.
void	list(java.lang.String teamId, int max, Space.SpaceType type, SpaceClient.SortBy sortBy, CompletionHandler<java.util.List<Space>> handler) Lists all spaces where the authenticated user belongs.
void	listWithActiveCalls(CompletionHandler<java.util.List<java.lang.String>> handler) Returns a list of spaces in which there are active calls.
void	listWithReadStatus(int max, CompletionHandler<java.util.List<SpaceReadStatus>> handler) Returns a list of SpaceReadStatus with details about the date of the last activity in the space, and the date of current user last presence in the space.
void	setSpaceObserver(SpaceObserver observer) Sets a SpaceObserver in this client.
void	update(java.lang.String spaceId, java.lang.String title, CompletionHandler<Space> handler) Updates the details for a space by id.

Method Detail

setSpaceObserver

void setSpaceObserver(SpaceObserver observer)

Sets a SpaceObserver in this client.

Parameters:

observer - the observer object.

Since:

2.3.0

See Also:

SpaceObserver

list

void list(@Nullable
          java.lang.String teamId,
          int max,
          @Nullable
          Space.SpaceType type,
          @Nullable
          SpaceClient.SortBy sortBy,
          @NonNull
          CompletionHandler<java.util.List<Space>> handler)

Lists all spaces where the authenticated user belongs.

Parameters:

teamId - If not nil, only list the spaces that are associated with the team by team id.

max - The maximum number of spaces in the response.

type - If not nil, only list the spaces of this type. Otherwise all spaces are listed.

sortBy - Sort results by space ID (id), most recent activity (lastactivity), or most recently created (created).

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

Since:

0.1

create

void create(@NonNull
            java.lang.String title,
            @Nullable
            java.lang.String teamId,
            @NonNull
            CompletionHandler<Space> handler)

Creates a space. The authenticated user is automatically added as a member of the space. See the Memberships API to learn how to add more people to the space.

Parameters:

title - A user-friendly name for the space.

teamId - If not nil, this space will be associated with the team by team id. Otherwise, this space is not associated with any team.

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

Since:

0.1

See Also:

MembershipClient

get

void get(@NonNull
         java.lang.String spaceId,
         @NonNull
         CompletionHandler<Space> handler)

Retrieves the details for a space by id.

Parameters:

spaceId - The identifier of the space.

handler - The queue on which the completion handler is dispatched.

Since:

0.1

update

void update(@NonNull
            java.lang.String spaceId,
            @NonNull
            java.lang.String title,
            @NonNull
            CompletionHandler<Space> handler)

Updates the details for a space by id.

Parameters:

spaceId - The identifier of the space.

title - A user-friendly name for the space.

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

Since:

0.1

delete

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

Deletes a space by id.

Parameters:

spaceId - The identifier of the space.

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

Since:

0.1

getMeetingInfo

void getMeetingInfo(@NonNull
                    java.lang.String spaceId,
                    @NonNull
                    CompletionHandler<SpaceMeetingInfo> handler)

Shows Webex meeting details for a space such as the SIP address, meeting URL, toll-free and toll dial-in numbers.

Parameters:

spaceId - The identifier of the space.

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

Since:

2.3.0

See Also:

SpaceMeetingInfo

getWithReadStatus

void getWithReadStatus(@NonNull
                       java.lang.String spaceId,
                       @NonNull
                       CompletionHandler<SpaceReadStatus> handler)

Returns a SpaceReadStatus with the details about the date of the last activity in the space, and the date of current user last presence in the space. For spaces where lastActivityDate > lastSeenDate the space can be considered to be "unread"

Parameters:

spaceId - The identifier of the space.

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

Since:

2.3.0

See Also:

SpaceReadStatus

listWithReadStatus

void listWithReadStatus(int max,
                        @NonNull
                        CompletionHandler<java.util.List<SpaceReadStatus>> handler)

Returns a list of SpaceReadStatus with details about the date of the last activity in the space, and the date of current user last presence in the space. The list is sorted with this with most recent activity first. For spaces where lastActivityDate > lastSeenDate the space can be considered to be "unread"

Parameters:

max - The maximum number of result, recommend that the parameter is limited between 1 and 100.

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

Since:

2.3.0

See Also:

SpaceReadStatus

listWithActiveCalls

void listWithActiveCalls(@NonNull
                         CompletionHandler<java.util.List<java.lang.String>> handler)

Returns a list of spaces in which there are active calls.

Parameters:

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

Since:

2.6.0