ScopeSet class

Pacote:
@azure/msal-common

A classe ScopeSet cria um conjunto de escopos. Escopos não diferenciam maiúsculas de minúsculas, valores exclusivos, portanto, o objeto Set no JS faz mais sentido implementar para essa classe. Todos os escopos são cortados e convertidos em cadeias de caracteres minúsculas em funções de interseção e união para garantir a exclusividade das cadeias de caracteres.

Construtores

ScopeSet(string[])

Métodos

appendScope(string)

Acrescenta um único escopo se passado
appendScopes(string[])

Acrescenta vários escopos se passado
asArray()

Retorna os escopos como uma matriz de valores de cadeia de caracteres
containsOnlyOIDCScopes()

Verifique se o conjunto de escopos contém apenas os padrões
containsScope(string)

Verifique se um determinado escopo está presente neste conjunto de escopos.
containsScopeSet(ScopeSet)

Verifique se um conjunto de escopos está presente neste conjunto de escopos.
createSearchScopes(string[])

Cria o conjunto de escopos a serem pesquisados em pesquisas de cache
fromString(string)

Método factory para criar ScopeSet a partir de cadeia de caracteres delimitada por espaço
getScopeCount()

Retorna o tamanho do conjunto de escopos.
intersectingScopeSets(ScopeSet)

Verifique se os escopos se cruzam entre esse conjunto e outro.
printScopes()

Imprime escopos em uma cadeia de caracteres delimitada por espaço
printScopesLowerCase()

Imprime escopos em uma cadeia de caracteres minúsculas delimitada por espaço (usada para cache)
removeOIDCScopes()

Remove escopos padrão do conjunto de escopos usados principalmente para evitar erros de cache se os escopos padrão não forem retornados do servidor
removeScope(string)

Remove o elemento do conjunto de escopos.
unionScopeSets(ScopeSet)

Combina uma matriz de escopos com o conjunto atual de escopos.

Detalhes do construtor

ScopeSet(string[]) 

new ScopeSet(inputScopes: string[])

Parâmetros

inputScopes

string[]

Detalhes do método

appendScope(string)

Acrescenta um único escopo se passado

function appendScope(newScope: string)

Parâmetros

newScope

string

appendScopes(string[])

Acrescenta vários escopos se passado

function appendScopes(newScopes: string[])

Parâmetros

newScopes

string[]

asArray()

Retorna os escopos como uma matriz de valores de cadeia de caracteres

function asArray(): string[]

Retornos

string[]

containsOnlyOIDCScopes()

Verifique se o conjunto de escopos contém apenas os padrões

function containsOnlyOIDCScopes(): boolean

Retornos

boolean

containsScope(string)

Verifique se um determinado escopo está presente neste conjunto de escopos.

function containsScope(scope: string): boolean

Parâmetros

scope

string

Retornos

boolean

containsScopeSet(ScopeSet)

Verifique se um conjunto de escopos está presente neste conjunto de escopos.

function containsScopeSet(scopeSet: ScopeSet): boolean

Parâmetros

scopeSet
ScopeSet

Retornos

boolean

createSearchScopes(string[])

Cria o conjunto de escopos a serem pesquisados em pesquisas de cache

static function createSearchScopes(inputScopeString: string[]): ScopeSet

Parâmetros

inputScopeString

string[]

Retornos

ScopeSet

fromString(string)

Método factory para criar ScopeSet a partir de cadeia de caracteres delimitada por espaço

static function fromString(inputScopeString: string): ScopeSet

Parâmetros

inputScopeString

string

Retornos

ScopeSet

getScopeCount()

Retorna o tamanho do conjunto de escopos.

function getScopeCount(): number

Retornos

number

intersectingScopeSets(ScopeSet)

Verifique se os escopos se cruzam entre esse conjunto e outro.

function intersectingScopeSets(otherScopes: ScopeSet): boolean

Parâmetros

otherScopes
ScopeSet

Retornos

boolean

printScopes()

Imprime escopos em uma cadeia de caracteres delimitada por espaço

function printScopes(): string

Retornos

string

printScopesLowerCase()

Imprime escopos em uma cadeia de caracteres minúsculas delimitada por espaço (usada para cache)

function printScopesLowerCase(): string

Retornos

string

removeOIDCScopes()

Remove escopos padrão do conjunto de escopos usados principalmente para evitar erros de cache se os escopos padrão não forem retornados do servidor

function removeOIDCScopes()

removeScope(string)

Remove o elemento do conjunto de escopos.

function removeScope(scope: string)

Parâmetros

scope

string

unionScopeSets(ScopeSet)

Combina uma matriz de escopos com o conjunto atual de escopos.

function unionScopeSets(otherScopes: ScopeSet): Set<string>

Parâmetros

otherScopes
ScopeSet

Retornos

Set<string>