SecurityRules class

Интерфейс службы Firebase SecurityRules .

Подпись:

export declare class SecurityRules 

Характеристики

Методы

SecurityRules.app

Подпись:

readonly app: App;

SecurityRules.createRuleset()

Создает новый набор правил из данного файла правил. .

Подпись:

createRuleset(file: RulesFile): Promise<Ruleset>;

Параметры

Возврат:

Обещание< Набор правил >

Обещание, которое выполняется с помощью недавно созданного Ruleset . .

SecurityRules.createRulesFileFromSource()

Создает RulesFile с заданным именем и источником. Выдает ошибку, если какой-либо из аргументов недействителен. Это локальная операция, которая не требует каких-либо вызовов сетевых API.

Подпись:

createRulesFileFromSource(name: string, source: string | Buffer): RulesFile;

Параметры

Возврат:

ПравилаФайл

Новый экземпляр файла правил.

Пример

const source = '// Some rules source';
const rulesFile = admin.securityRules().createRulesFileFromSource(
  'firestore.rules', source);

SecurityRules.deleteRuleset()

Удаляет набор правил , определенный по данному имени. Входное имя должно представлять собой короткую строку имени без префикса идентификатора проекта. Например, чтобы удалить projects/project-id/rulesets/my-ruleset , передайте короткое имя «my-ruleset». Отклоняется с ошибкой not-found , если указанный Ruleset не найден.

Подпись:

deleteRuleset(name: string): Promise<void>;

Параметры

Возврат:

Обещание<void>

Обещание, которое выполняется при удалении Ruleset .

SecurityRules.getFirestoreRuleset()

Получает набор правил , применяемый в данный момент к Cloud Firestore. Отклоняется с ошибкой not-found , если в Firestore не применяется набор правил.

Подпись:

getFirestoreRuleset(): Promise<Ruleset>;

Возврат:

Обещание< Набор правил >

Обещание, соответствующее набору правил Firestore.

SecurityRules.getRuleset()

Получает набор правил , идентифицированный по заданному имени. Входное имя должно представлять собой короткую строку имени без префикса идентификатора проекта. Например, чтобы получить файлы projects/project-id/rulesets/my-ruleset , передайте короткое имя «my-ruleset». Отклоняется с ошибкой not-found , если указанный Ruleset не найден.

Подпись:

getRuleset(name: string): Promise<Ruleset>;

Параметры

Возврат:

Обещание< Набор правил >

Обещание, которое выполняется с указанным Ruleset .

SecurityRules.getStorageRuleset()

Получает набор правил , применяемый в данный момент к сегменту Cloud Storage. Отклоняется с ошибкой not-found , если к сегменту не применен набор правил.

Подпись:

getStorageRuleset(bucket?: string): Promise<Ruleset>;

Параметры

Возврат:

Обещание< Набор правил >

Обещание, соответствующее набору правил Cloud Storage.

SecurityRules.listRulesetMetadata()

Получает страницу метаданных набора правил.

Подпись:

listRulesetMetadata(pageSize?: number, nextPageToken?: string): Promise<RulesetMetadataList>;

Параметры

Возврат:

Обещание < RulesetMetadataList >

Обещание, которое выполняется со страницей наборов правил.

SecurityRules.releaseFirestoreRuleset()

Применяет указанный набор правил набора правил к Cloud Firestore.

Подпись:

releaseFirestoreRuleset(ruleset: string | RulesetMetadata): Promise<void>;

Параметры

Возврат:

Обещание<void>

Обещание, которое выполняется после выпуска набора правил.

SecurityRules.releaseFirestoreRulesetFromSource()

Создает новый набор правил из заданного источника и применяет его к Cloud Firestore.

Подпись:

releaseFirestoreRulesetFromSource(source: string | Buffer): Promise<Ruleset>;

Параметры

Возврат:

Обещание< Набор правил >

Обещание, которое выполняется при создании и выпуске набора правил.

SecurityRules.releaseStorageRuleset()

Применяет указанный набор правил к сегменту Cloud Storage.

Подпись:

releaseStorageRuleset(ruleset: string | RulesetMetadata, bucket?: string): Promise<void>;

Параметры

Возврат:

Обещание<void>

Обещание, которое выполняется после выпуска набора правил.

SecurityRules.releaseStorageRulesetFromSource()

Создает новый набор правил из заданного источника и применяет его к сегменту Cloud Storage.

Подпись:

releaseStorageRulesetFromSource(source: string | Buffer, bucket?: string): Promise<Ruleset>;

Параметры

Возврат:

Обещание< Набор правил >

Обещание, которое выполняется при создании и выпуске набора правил.