interface-icurrentusercommands

Interface: ICurrentUserCommands

Commands related to the current user

Hierarchy

  • ICurrentUserCommands

Index

Methods

Methods

getCurrentAccountPermissions

getCurrentAccountPermissions(): Promise<AccountPermission[]>

Gets the permissions of the current user over the account (team).

Requires scope: IDENTITY:READ

Returns: Promise<AccountPermission[]>

a promise resolving into an array of AccountPermission(strings)


getCurrentBoardPermissions

getCurrentBoardPermissions(): Promise<BoardPermission[]>

Gets the permissions of the current user over the current board.

Requires scope: IDENTITY:READ

Returns: Promise<BoardPermission[]>

a promise resolving into an array of BoardPermission(strings)


getId

getId(): Promise<string>

Gets the user id

Returns: Promise<string>

a promise resolving in the current user id


getScopes

getScopes(): Promise<string[]>

Gets the current scopes the user has authorized the plugin

Returns: Promise<string[]>

a promise resolving into an array of scopes (strings) the user has authorized the plugin.


isMemberOfCurrentAccount

isMemberOfCurrentAccount(): Promise<boolean>

Returns if the current user is a member of the account (team) owner of the board

Requires scope: IDENTITY:READ

Returns: Promise<boolean>

a promise resolving into the membership status of the current user (boolean)


isSignedIn

isSignedIn(): Promise<boolean>

Returns if the user is logged in.

Returns: Promise<boolean>

a promise resolved into the login status of the current user (true or false)


Did this page help you?