- Preparing search index...
- The search index is not available
Entity
Function describePrivacyPolicyRule
- describePrivacyPolicyRule<TFields, TID, TViewerContext, TEntity, TSelectedFields>(privacyPolicyRule, __namedParameters): void
-
Type Parameters
-
TFields extends object
-
TID extends {}
-
TViewerContext extends ViewerContext<TViewerContext>
-
TEntity extends ReadonlyEntity<TFields, TID, TViewerContext, TSelectedFields, TEntity>
-
TSelectedFields extends string | number | symbol = keyof TFields
Parameters
-
privacyPolicyRule: PrivacyPolicyRule<TFields, TID, TViewerContext, TEntity, TSelectedFields>
-
__namedParameters: {
allowCases?: Case<TFields, TID, TViewerContext, TEntity, TSelectedFields>[];
denyCases?: Case<TFields, TID, TViewerContext, TEntity, TSelectedFields>[];
skipCases?: Case<TFields, TID, TViewerContext, TEntity, TSelectedFields>[];
}
-
Optional allowCases?: Case<TFields, TID, TViewerContext, TEntity, TSelectedFields>[]
-
Optional denyCases?: Case<TFields, TID, TViewerContext, TEntity, TSelectedFields>[]
-
Optional skipCases?: Case<TFields, TID, TViewerContext, TEntity, TSelectedFields>[]
Returns void
For test simple privacy rules that don't have complex async preconditions.