TeamClient Class Reference


                    
                    
                    TeamArchiveError

Enum for errors that can occur when archiving a team

Declaration

Swift

public enum TeamArchiveError : String


                    
                    
                    TeamUpdateError

Enum for errors that can occur when updating a Team

Declaration

Swift

public enum TeamUpdateError : String


                    
                    
                    list(max:queue:completionHandler:)

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 (Result<[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


                    
                    
                    create(name:queue:completionHandler:)

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 TeamMembershipClient API

Declaration

Swift

public func create(name: String, queue: DispatchQueue? = nil, completionHandler: @escaping (Result<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


                    
                    
                    get(teamId:queue:completionHandler:)

Retrieves the details for a team by id.

Since

1.2.0

Declaration

Swift

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

Parameters

`teamId`	The identifier of the team. (Derived parameter: Use `TeamClient.list(...)` to get a list of teams. Then use `Team.id` to retrieve the teamId)
`queue`	The queue on which the completion handler is dispatched.
`completionHandler`	A closure to be executed once the request has finished.

Return Value

Void


                    
                    
                    update(teamId:name:queue:completionHandler:)

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 (Result<Team>) -> Void)

Parameters

`teamId`	The team id. (Derived parameter: Use `TeamClient.list(...)` to get a list of teams. Then use `Team.id` to retrieve the teamId)
`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


                    
                    
                    delete(teamId:queue:completionHandler:)

Deletes a team by id.

Since

1.2.0

Declaration

Swift

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

Parameters

`teamId`	The team id. (Derived parameter: Use `TeamClient.list(...)` to get a list of teams. Then use `Team.id` to retrieve the teamId)
`queue`	The queue on which the completion handler is dispatched.
`completionHandler`	A closure to be executed once the request has finished.

Return Value

Void