com.ciscospark.androidsdk.room

Interface RoomClient

public interface RoomClient

A client wrapper of the Cisco Spark Rooms REST API

Since:

0.1

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	RoomClient.SortBy Sort results by room 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<Room> handler) Creates a room.
void	delete(java.lang.String roomId, CompletionHandler<java.lang.Void> handler) Deletes a room by id.
void	get(java.lang.String roomId, CompletionHandler<Room> handler) Retrieves the details for a room by id.
void	list(java.lang.String teamId, int max, Room.RoomType type, RoomClient.SortBy sortBy, CompletionHandler<java.util.List<Room>> handler) Lists all rooms where the authenticated user belongs.
void	update(java.lang.String roomId, java.lang.String title, CompletionHandler<Room> handler) Updates the details for a room by id.

Method Detail

list

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

Lists all rooms where the authenticated user belongs.

Parameters:

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

max - The maximum number of rooms in the response.

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

sortBy - Sort results by room 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<Room> handler)

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

Parameters:

title - A user-friendly name for the room.

teamId - If not nil, this room will be associated with the team by team id. Otherwise, this room 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 roomId,
         @NonNull
         CompletionHandler<Room> handler)

Retrieves the details for a room by id.

Parameters:

roomId - The identifier of the room.

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

Since:

0.1

update

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

Updates the details for a room by id.

Parameters:

roomId - The identifier of the room.

title - A user-friendly name for the room.

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

Since:

0.1

delete

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

Deletes a room by id.

Parameters:

roomId - The identifier of the room.

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

Since:

0.1