Compartilhar via


AccountsRestClient class

Classe base que deve ser usada (derivada de) para fazer solicitações para apis REST do VSS

Extends

Construtores

AccountsRestClient(IVssRestClientOptions)

Propriedades

RESOURCE_AREA_ID

Métodos

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

Obtenha uma lista de contas para um proprietário específico ou um membro específico. Um dos seguintes parâmetros é necessário: ownerId, memberId.

Detalhes do construtor

AccountsRestClient(IVssRestClientOptions)

new AccountsRestClient(options: IVssRestClientOptions)

Parâmetros

Detalhes da propriedade

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

Valor da propriedade

string

Detalhes do método

createAccount(AccountCreateInfoInternal, boolean)

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

Parâmetros

usePrecreated

boolean

Retornos

Promise<Account>

getAccount(string)

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

Parâmetros

accountId

string

Retornos

Promise<Account>

getAccounts(string, string, string)

Obtenha uma lista de contas para um proprietário específico ou um membro específico. Um dos seguintes parâmetros é necessário: ownerId, memberId.

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

Parâmetros

ownerId

string

ID do proprietário das contas.

memberId

string

ID para um membro das contas.

properties

string

Retornos

Promise<Account[]>