Skip to main content
Version: v2

ScopeType Enum

Defines scope access for a Container/Document.

This API is provided for existing users, but is not recommended for new users.

To use, import via @fluidframework/driver-definitions/legacy.

For more information about our API support guarantees, see here.

Signature​

export declare enum ScopeType

Flags​

FlagAlertsDescription
DocReadBetaRead access is supported on the Container/Document
DocWriteBetaWrite access is supported on the Container/Document
SummaryWriteBetaUser can generate new summaries operations

DocRead​

Read access is supported on the Container/Document

This API is provided for existing users, but is not recommended for new users.

For more information about our API support guarantees, see here.

Signature​

DocRead = "doc:read"

DocWrite​

Write access is supported on the Container/Document

This API is provided for existing users, but is not recommended for new users.

For more information about our API support guarantees, see here.

Signature​

DocWrite = "doc:write"

SummaryWrite​

User can generate new summaries operations

This API is provided for existing users, but is not recommended for new users.

For more information about our API support guarantees, see here.

Signature​

SummaryWrite = "summary:write"