Condividi tramite


AccountsRestClient class

Classe di base che deve essere usata (derivata da) per effettuare richieste alle API REST di VSS

Extends

Costruttori

AccountsRestClient(IVssRestClientOptions)

Proprietà

RESOURCE_AREA_ID

Metodi

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

Ottenere un elenco di account per un proprietario specifico o un membro specifico. È necessario uno dei parametri seguenti: ownerId, memberId.

Dettagli costruttore

AccountsRestClient(IVssRestClientOptions)

new AccountsRestClient(options: IVssRestClientOptions)

Parametri

Dettagli proprietà

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

Valore della proprietà

string

Dettagli metodo

createAccount(AccountCreateInfoInternal, boolean)

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

Parametri

usePrecreated

boolean

Restituisce

Promise<Account>

getAccount(string)

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

Parametri

accountId

string

Restituisce

Promise<Account>

getAccounts(string, string, string)

Ottenere un elenco di account per un proprietario specifico o un membro specifico. È necessario uno dei parametri seguenti: ownerId, memberId.

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

Parametri

ownerId

string

ID per il proprietario degli account.

memberId

string

ID per un membro degli account.

properties

string

Restituisce

Promise<Account[]>