ngx-appwrite
Version:
A wrapper around the Appwrite WebSDK for easier implementation in Angular 16+ projects. The goal is to make the whole SDK accessible as well as provide some convenience functionality like RxJS streams where appropriate.
166 lines (165 loc) • 6.28 kB
TypeScript
import { Models } from 'appwrite';
import * as i0 from "@angular/core";
export declare class TeamsService {
private _teams;
/**
* Create Team
*
* Create a new team. The user who creates the team will automatically be
* assigned as the owner of the team. Only the users with the owner role can
* invite new members, add new owners and delete or update the team.
*
* @param {string} teamId
* @param {string} name
* @param {string[]} roles
* @throws {AppwriteException}
* @returns {Promise<Models.Team<TPrefs>>}
*/
create<TPrefs extends Models.Preferences>(name: string, roles?: string[], teamId?: string): Promise<Models.Team<TPrefs>>;
/**
* List Teams
*
* Get a list of all the teams in which the current user is a member. You can
* use the parameters to filter your results.
*
* @param {string[]} queries
* @param {string} search
* @throws {Promise<Models.TeamList<TPrefs>>}
* @returns {Promise}
*/
list<TPrefs extends Models.Preferences>(queries?: string[] | undefined, search?: string | undefined): Promise<Models.TeamList<TPrefs>>;
/**
* Get Team
*
* Get a team by its ID. All team members have read access for this resource.
*
* @param {string} teamId
* @throws {AppwriteException}
* @returns {Promise<Models.Team<TPrefs>>}
*/
get<TPrefs extends Models.Preferences>(teamId: string): Promise<Models.Team<TPrefs>>;
/**
* Update Team Name
*
* Update a team name using its ID. Only members with the owner role can update the
* team.
*
* @param {string} teamId
* @param {string} name
* @throws {AppwriteException}
* @returns {Promise}
*/
updateName<TPrefs extends Models.Preferences>(teamId: string, name: string): Promise<Models.Team<TPrefs>>;
/**
* Delete Team
*
* Delete a team using its ID. Only team members with the owner role can
* delete the team.
*
* @param {string} teamId
* @throws {AppwriteException}
* @returns {Promise}
*/
delete(teamId: string): Promise<{}>;
/**
* Create Team Membership
*
* Invite a new member to join your team. If initiated from the client SDK, an
* email with a link to join the team will be sent to the member's email
* address and an account will be created for them should they not be signed
* up already. If initiated from server-side SDKs, the new member will
* automatically be added to the team.
*
* Use the 'url' parameter to redirect the user from the invitation email back
* to your app. When the user is redirected, use the [Update Team Membership
* Status](/docs/client/teams#teamsUpdateMembershipStatus) endpoint to allow
* the user to accept the invitation to the team.
*
* Please note that to avoid a [Redirect
* Attack](https://github.com/OWASP/CheatSheetSeries/blob/master/cheatsheets/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.md)
* the only valid redirect URL's are the once from domains you have set when
* adding your platforms in the console interface.
*
* @param {string} teamId
* @param {string} email
* @param {string[]} roles
* @param {string} url
* @param {string} name
* @throws {AppwriteException}
* @returns {Promise<Models.Membership>}
*/
createMembership(teamId: string, roles: string[], email?: string, url?: string, name?: string | undefined): Promise<Models.Membership>;
/**
* List Team Memberships
*
* Use this endpoint to list a team's members using the team's ID. All team
* members have read access to this endpoint.
*
* @param {string} teamId
* @param {string[]} queries
* @param {string} search
* @throws {AppwriteException}
* @returns {Promise<Models.MembershipList>}
*/
listMemberships(teamId: string, queries?: string[] | undefined, search?: string | undefined): Promise<Models.MembershipList>;
/**
* Get Team Membership
*
* Get a team member by the membership unique id. All team members have read
* access for this resource.
*
* @param {string} teamId
* @param {string} membershipId
* @throws {AppwriteException}
* @returns {Promise<Models.Membership>}
*/
getMembership(teamId: string, membershipId: string): Promise<Models.Membership>;
/**
* Update Membership
*
* Modify the roles of a team member. Only team members with the owner role
* have access to this endpoint. Learn more about [roles and
* permissions](/docs/permissions).
*
* @param {string} teamId
* @param {string} membershipId
* @param {string[]} roles
* @throws {AppwriteException}
* @returns {Promise<Models.Membership>}
*/
updateMembership(teamId: string, membershipId: string, roles: string[]): Promise<Models.Membership>;
/**
* Update Team Membership Status
*
* Use this endpoint to allow a user to accept an invitation to join a team
* after being redirected back to your app from the invitation email received
* by the user.
*
* If the request is successful, a session for the user is automatically
* created.
*
*
* @param {string} teamId
* @param {string} membershipId
* @param {string} userId
* @param {string} secret
* @throws {AppwriteException}
* @returns {Promise}
*/
updateMembershipStatus(teamId: string, membershipId: string, userId: string, secret: string): Promise<Models.Membership>;
/**
* Delete Team Membership
*
* This endpoint allows a user to leave a team or for a team owner to delete
* the membership of any other team member. You can also use this endpoint to
* delete a user membership even if it is not accepted.
*
* @param {string} teamId
* @param {string} membershipId
* @throws {AppwriteException}
* @returns {Promise}
*/
deleteMembership(teamId: string, membershipId: string): Promise<{}>;
static ɵfac: i0.ɵɵFactoryDeclaration<TeamsService, never>;
static ɵprov: i0.ɵɵInjectableDeclaration<TeamsService>;
}