ScopeSet class

Пакет:

@azure/msal-common

Класс ScopeSet создает набор областей. Области являются нечувствительными к регистру, уникальными значениями, поэтому объект Set в JS имеет наибольшее значение для реализации этого класса. Все области обрезаются и преобразуются в строки нижнего регистра в функциях пересечения и объединения, чтобы обеспечить уникальность строк.

Конструкторы

ScopeSet(string[])

Методы

appendScope(string)	Добавляет одну область при передаче
appendScopes(string[])	Добавляет несколько областей при передаче
asArray()	Возвращает области в виде массива строковых значений
containsOnlyOIDCScopes()	Проверьте, содержит ли набор областей только значения по умолчанию.
containsScope(string)	Проверьте, присутствует ли данная область в этом наборе областей.
containsScopeSet(ScopeSet)	Проверьте, присутствует ли набор областей в этом наборе областей.
createSearchScopes(string[])	Создает набор областей для поиска в поисках кэша
fromString(string)	Метод фабрики для создания ScopeSet из строки с разделителями пространства
getScopeCount()	Возвращает размер набора областей.
intersectingScopeSets(ScopeSet)	Проверьте, пересекаются ли области между этим набором и другим.
printScopes()	Печать областей в строке с разделителями пробелов
printScopesLowerCase()	Печатает области в строке нижнего регистра с разделителями пробелов (используется для кэширования)
removeOIDCScopes()	Удаляет области по умолчанию из набора областей в основном используется для предотвращения промахов кэша, если области по умолчанию не возвращаются с сервера.
removeScope(string)	Удаляет элемент из набора областей.
unionScopeSets(ScopeSet)	Объединяет массив областей с текущим набором областей.

Сведения о конструкторе

ScopeSet(string[])

new ScopeSet(inputScopes: string[])

Параметры

inputScopes

string[]

Сведения о методе

appendScope(string)

Добавляет одну область при передаче

function appendScope(newScope: string)

Параметры

newScope

string

appendScopes(string[])

Добавляет несколько областей при передаче

function appendScopes(newScopes: string[])

Параметры

newScopes

string[]

asArray()

Возвращает области в виде массива строковых значений

function asArray(): string[]

Возвращаемое значение

string[]

containsOnlyOIDCScopes()

Проверьте, содержит ли набор областей только значения по умолчанию.

function containsOnlyOIDCScopes(): boolean

Возвращаемое значение

boolean

containsScope(string)

Проверьте, присутствует ли данная область в этом наборе областей.

function containsScope(scope: string): boolean

Параметры

scope

string

Возвращаемое значение

boolean

containsScopeSet(ScopeSet)

Проверьте, присутствует ли набор областей в этом наборе областей.

function containsScopeSet(scopeSet: ScopeSet): boolean

Параметры

scopeSet

ScopeSet

Возвращаемое значение

boolean

createSearchScopes(string[])

Создает набор областей для поиска в поисках кэша

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

Параметры

inputScopeString

string[]

Возвращаемое значение

ScopeSet

fromString(string)

Метод фабрики для создания ScopeSet из строки с разделителями пространства

static function fromString(inputScopeString: string): ScopeSet

Параметры

inputScopeString

string

Возвращаемое значение

ScopeSet

getScopeCount()

Возвращает размер набора областей.

function getScopeCount(): number

Возвращаемое значение

number

intersectingScopeSets(ScopeSet)

Проверьте, пересекаются ли области между этим набором и другим.

function intersectingScopeSets(otherScopes: ScopeSet): boolean

Параметры

otherScopes

ScopeSet

Возвращаемое значение

boolean

printScopes()

Печать областей в строке с разделителями пробелов

function printScopes(): string

Возвращаемое значение

string

printScopesLowerCase()

Печатает области в строке нижнего регистра с разделителями пробелов (используется для кэширования)

function printScopesLowerCase(): string

Возвращаемое значение

string

removeOIDCScopes()

Удаляет области по умолчанию из набора областей в основном используется для предотвращения промахов кэша, если области по умолчанию не возвращаются с сервера.

function removeOIDCScopes()

removeScope(string)

Удаляет элемент из набора областей.

function removeScope(scope: string)

Параметры

scope

string

unionScopeSets(ScopeSet)

Объединяет массив областей с текущим набором областей.

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

Параметры

otherScopes

ScopeSet

Возвращаемое значение

Set<string>