appwrite

package
v5.1.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jun 5, 2026 License: BSD-3-Clause Imports: 25 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func NewAccount

func NewAccount(clt client.Client) *account.Account

func NewActivities

func NewActivities(clt client.Client) *activities.Activities

func NewAdvisor

func NewAdvisor(clt client.Client) *advisor.Advisor

func NewAvatars

func NewAvatars(clt client.Client) *avatars.Avatars

func NewBackups

func NewBackups(clt client.Client) *backups.Backups

func NewClient

func NewClient(optionalSetters ...client.ClientOption) client.Client

NewClient initializes a new Appwrite client with a given timeout

func NewDatabases

func NewDatabases(clt client.Client) *databases.Databases

func NewFunctions

func NewFunctions(clt client.Client) *functions.Functions

func NewGraphql

func NewGraphql(clt client.Client) *graphql.Graphql

func NewHealth

func NewHealth(clt client.Client) *health.Health

func NewLocale

func NewLocale(clt client.Client) *locale.Locale

func NewMessaging

func NewMessaging(clt client.Client) *messaging.Messaging

func NewOrganization

func NewOrganization(clt client.Client) *organization.Organization

func NewPresences

func NewPresences(clt client.Client) *presences.Presences

func NewProject

func NewProject(clt client.Client) *project.Project

func NewProxy

func NewProxy(clt client.Client) *proxy.Proxy

func NewSites

func NewSites(clt client.Client) *sites.Sites

func NewStorage

func NewStorage(clt client.Client) *storage.Storage

func NewTablesDB

func NewTablesDB(clt client.Client) *tablesdb.TablesDB

func NewTeams

func NewTeams(clt client.Client) *teams.Teams

func NewTokens

func NewTokens(clt client.Client) *tokens.Tokens

func NewUsage

func NewUsage(clt client.Client) *usage.Usage

func NewUsers

func NewUsers(clt client.Client) *users.Users

func NewWebhooks

func NewWebhooks(clt client.Client) *webhooks.Webhooks

func WithChunkSize

func WithChunkSize(size int64) client.ClientOption

Helper method to construct NewClient()

func WithCookie

func WithCookie(value string) client.ClientOption

Helper method to construct NewClient()

The user cookie to authenticate with. Used by SDKs that forward an incoming Cookie header in server-side runtimes.

func WithDevKey

func WithDevKey(value string) client.ClientOption

Helper method to construct NewClient()

Your secret dev API key

func WithEndpoint

func WithEndpoint(endpoint string) client.ClientOption

Helper method to construct NewClient()

func WithForwardedUserAgent

func WithForwardedUserAgent(value string) client.ClientOption

Helper method to construct NewClient()

The user agent string of the client that made the request

func WithImpersonateUserEmail

func WithImpersonateUserEmail(value string) client.ClientOption

Helper method to construct NewClient()

Impersonate a user by email on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data.

func WithImpersonateUserId

func WithImpersonateUserId(value string) client.ClientOption

Helper method to construct NewClient()

Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data.

func WithImpersonateUserPhone

func WithImpersonateUserPhone(value string) client.ClientOption

Helper method to construct NewClient()

Impersonate a user by phone on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data.

func WithJWT

func WithJWT(value string) client.ClientOption

Helper method to construct NewClient()

Your secret JSON Web Token

func WithKey

func WithKey(value string) client.ClientOption

Helper method to construct NewClient()

Your secret API key

func WithLocale

func WithLocale(value string) client.ClientOption

Helper method to construct NewClient()

func WithProject

func WithProject(value string) client.ClientOption

Helper method to construct NewClient()

Your project ID

func WithSelfSigned

func WithSelfSigned(status bool) client.ClientOption

Helper method to construct NewClient()

func WithSession

func WithSession(value string) client.ClientOption

Helper method to construct NewClient()

The user session to authenticate with

func WithTimeout

func WithTimeout(timeout time.Duration) client.ClientOption

Helper method to construct NewClient()

Types

This section is empty.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL