Delen via


AccountsRestClient class

Basisklasse die moet worden gebruikt (afgeleid van) om aanvragen te doen voor VSS REST API's

Extends

Constructors

AccountsRestClient(IVssRestClientOptions)

Eigenschappen

RESOURCE_AREA_ID

Methoden

createAccount(AccountCreateInfoInternal, boolean)
getAccount(string)
getAccounts(string, string, string)

Een lijst met accounts ophalen voor een specifieke eigenaar of een specifiek lid. Een van de volgende parameters is vereist: ownerId, memberId.

Constructordetails

AccountsRestClient(IVssRestClientOptions)

new AccountsRestClient(options: IVssRestClientOptions)

Parameters

Eigenschapdetails

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

Waarde van eigenschap

string

Methodedetails

createAccount(AccountCreateInfoInternal, boolean)

function createAccount(info: AccountCreateInfoInternal, usePrecreated?: boolean): Promise<Account>

Parameters

usePrecreated

boolean

Retouren

Promise<Account>

getAccount(string)

function getAccount(accountId: string): Promise<Account>

Parameters

accountId

string

Retouren

Promise<Account>

getAccounts(string, string, string)

Een lijst met accounts ophalen voor een specifieke eigenaar of een specifiek lid. Een van de volgende parameters is vereist: ownerId, memberId.

function getAccounts(ownerId?: string, memberId?: string, properties?: string): Promise<Account[]>

Parameters

ownerId

string

Id voor de eigenaar van de accounts.

memberId

string

Id voor een lid van de accounts.

properties

string

Retouren

Promise<Account[]>