TeamClient

public class TeamClient

An iOS client wrapper of the Cisco Spark Teams REST API .

Since

1.2.0

  • Lists teams to which the authenticated user belongs.

    Since

    1.2.0

    Declaration

    Swift

    public func list(max: Int? = nil, queue: DispatchQueue? = nil, completionHandler: @escaping (ServiceResponse<[Team]>) -> Void)

    Parameters

    max

    The maximum number of teams in the response.
    queue

    The queue on which the completion handler is dispatched.
    completionHandler

    A closure to be executed once the request has finished.

    Return Value

    Void

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

    Since

    1.2.0

    See

    see TeamMemebershipClient API

    Declaration

    Swift

    public func create(name: String, queue: DispatchQueue? = nil, completionHandler: @escaping (ServiceResponse<Team>) -> Void)

    Parameters

    title

    A user-friendly name for the team.
    queue

    The queue on which the completion handler is dispatched.
    completionHandler

    A closure to be executed once the request has finished.

    Return Value

    Void

  • Retrieves the details for a team by id.

    Since

    1.2.0

    Declaration

    Swift

    public func get(teamId: String, queue: DispatchQueue? = nil, completionHandler: @escaping (ServiceResponse<Team>) -> Void)

    Parameters

    teamId

    The identifier of the team.
    queue

    The queue on which the completion handler is dispatched.
    completionHandler

    A closure to be executed once the request has finished.

    Return Value

    Void

  • Updates the details for a team by id.

    Since

    1.2.0

    Declaration

    Swift

    public func update(teamId: String, name: String, queue: DispatchQueue? = nil, completionHandler: @escaping (ServiceResponse<Team>) -> Void)

    Parameters

    teamId

    The team id.
    name

    A user-friendly name for the team.
    queue

    The queue on which the completion handler is dispatched.
    completionHandler

    A closure to be executed once the request has finished.

    Return Value

    Void

  • Deletes a team by id.

    Since

    1.2.0

    Declaration

    Swift

    public func delete(teamId: String, queue: DispatchQueue? = nil, completionHandler: @escaping (ServiceResponse<Any>) -> Void)

    Parameters

    teamId

    The team id.
    queue

    The queue on which the completion handler is dispatched.
    completionHandler

    A closure to be executed once the request has finished.

    Return Value

    Void