Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Client

GIFBox API Client

Hierarchy

  • Client

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

Private #axios

#axios: ClientAxios

Instance of Axios.

Private #bearerToken

#bearerToken: null | string = null

Currently used Bearer authorization token.

Private #clientUser

#clientUser: null | ClientUser = null

User the client is authorized as.

Accessors

clientUser

post

token

  • get token(): null | string

user

Methods

Private #updateClientUser

  • #updateClientUser(): Promise<void>

createSession

  • createSession(email: string, password: string, sessionName: string): Promise<void>

  • Login as existent user if there is no token present yet.

    Parameters

    • email: string
    • password: string
    • sessionName: string

      Name of the new session, will be displayed to the user.

    Returns Promise<void>

deleteSession

  • deleteSession(sessionId: string): Promise<void>

  • Delete an existing session.

    Parameters

    • sessionId: string

    Returns Promise<void>

getCurrentSession

getSessions

loginBearer

  • loginBearer(token: string): Promise<void>

  • Login with an already existent session token.

    Parameters

    • token: string

    Returns Promise<void>

logout

  • logout(): Promise<void>

  • Log out, then reset token and client user to null.

    Returns Promise<void>

modifySelf

modifySession

setAvatar

  • Set a new avatar. avatar should be a common-format image that {@link FormData} understands.

    Parameters

    • avatar: any

    Returns Promise<GenericSuccess>

unsetAvatar

Generated using TypeDoc