Appwrite.Services.Teams (appwrite v1.0.0)

The Teams service allows you to group users of your project and to enable them to share read and write access to your project resources.

Summary

Functions

create(team_id, name, roles \\ nil)

Create a new Team.

create_membership(team_id, roles, email \\ nil, user_id \\ nil, phone \\ nil, url \\ nil, name \\ nil)

Invite a user to the team (create a membership).

delete(team_id)

Delete a Team by its unique ID.

delete_membership(team_id, membership_id)

Remove a user from the team (delete membership).

get(team_id)

Get a Team by its unique ID.

get_membership(team_id, membership_id)

Get a membership by its unique ID.

get_prefs(team_id)

Get a Team's preferences.

list(queries \\ nil, search \\ nil, total \\ nil)

List all Teams the current user belongs to.

list_memberships(team_id, queries \\ nil, search \\ nil, total \\ nil)

List memberships for a Team.

update(team_id, name)

Update a Team's name.

update_membership(team_id, membership_id, roles)

Update a membership's roles.

update_membership_status(team_id, membership_id, user_id, secret)

Accept an invitation (update membership status).

update_name(team_id, name)

Update a Team's name (preferred alias for update/2).

update_prefs(team_id, prefs)

Update a Team's preferences.

Functions

create(team_id, name, roles \\ nil)

@spec create(String.t(), String.t(), [String.t()] | nil) ::
  {:ok, map()} | {:error, any()}

Create a new Team.

create_membership(team_id, roles, email \\ nil, user_id \\ nil, phone \\ nil, url \\ nil, name \\ nil)

@spec create_membership(
  String.t(),
  [String.t()],
  String.t() | nil,
  String.t() | nil,
  String.t() | nil,
  String.t() | nil,
  String.t() | nil
) :: {:ok, map()} | {:error, any()}

Invite a user to the team (create a membership).

delete(team_id)

@spec delete(String.t()) :: {:ok, map()} | {:error, any()}

Delete a Team by its unique ID.

delete_membership(team_id, membership_id)

@spec delete_membership(String.t(), String.t()) :: {:ok, map()} | {:error, any()}

Remove a user from the team (delete membership).

get(team_id)

@spec get(String.t()) :: {:ok, map()} | {:error, any()}

Get a Team by its unique ID.

get_membership(team_id, membership_id)

@spec get_membership(String.t(), String.t()) :: {:ok, map()} | {:error, any()}

Get a membership by its unique ID.

get_prefs(team_id)

@spec get_prefs(String.t()) :: {:ok, map()} | {:error, any()}

Get a Team's preferences.

list(queries \\ nil, search \\ nil, total \\ nil)

@spec list([String.t()] | nil, String.t() | nil, boolean() | nil) ::
  {:ok, map()} | {:error, any()}

List all Teams the current user belongs to.

Parameters

queries (optional)
search (optional)
total (optional) — when false, skips count calculation

list_memberships(team_id, queries \\ nil, search \\ nil, total \\ nil)

@spec list_memberships(
  String.t(),
  [String.t()] | nil,
  String.t() | nil,
  boolean() | nil
) ::
  {:ok, map()} | {:error, any()}

List memberships for a Team.

Parameters

team_id (required)
queries (optional)
search (optional)
total (optional) — when false, skips count calculation

update(team_id, name)

@spec update(String.t(), String.t()) :: {:ok, map()} | {:error, any()}

Update a Team's name.

update_membership(team_id, membership_id, roles)

@spec update_membership(String.t(), String.t(), [String.t()]) ::
  {:ok, map()} | {:error, any()}

Update a membership's roles.

update_membership_status(team_id, membership_id, user_id, secret)

@spec update_membership_status(String.t(), String.t(), String.t(), String.t()) ::
  {:ok, map()} | {:error, any()}

Accept an invitation (update membership status).

update_name(team_id, name)

@spec update_name(String.t(), String.t()) :: {:ok, map()} | {:error, any()}

Update a Team's name (preferred alias for update/2).

update_prefs(team_id, prefs)

@spec update_prefs(String.t(), map()) :: {:ok, map()} | {:error, any()}

Update a Team's preferences.