Users | /mod.ts | appwrite@0.2.2

class Users

extends Service

Re-export

import { Users } from "https://deno.land/x/appwrite@0.2.2/mod.ts";

Methods

create<T extends unknown>(

email: string,

password: string,

name?: string,

): Promise<T>

Create User

Create a new user.

delete<T extends unknown>(userId: string): Promise<T>

Delete User

Delete a user by its unique ID.

deleteSession<T extends unknown>(userId: string, sessionId: string): Promise<T>

Delete User Session

Delete a user sessions by its unique ID.

deleteSessions<T extends unknown>(userId: string): Promise<T>

Delete User Sessions

Delete all user's sessions by using the user's unique ID.

get<T extends unknown>(userId: string): Promise<T>

Get User

Get a user by its unique ID.

getLogs<T extends unknown>(userId: string): Promise<T>

Get User Logs

Get a user activity logs list by its unique ID.

getPrefs<T extends unknown>(userId: string): Promise<T>

Get User Preferences

Get the user preferences by its unique ID.

getSessions<T extends unknown>(userId: string): Promise<T>

Get User Sessions

Get the user sessions list by its unique ID.

list<T extends unknown>(

search?: string,

limit?: number,

offset?: number,

orderType?: string,

): Promise<T>

List Users

Get a list of all the project's users. You can use the query params to filter your results.

updatePrefs<T extends unknown>(userId: string, prefs: object): Promise<T>

Update User Preferences

Update the user preferences by its unique ID. You can pass only the specific settings you wish to update.

updateStatus<T extends unknown>(userId: string, status: number): Promise<T>

Update User Status

Update the user status by its unique ID.