Skip to main content

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

Flag Alerts Description
DocRead Alpha Read access is supported on the Container/Document
DocWrite Alpha Write access is supported on the Container/Document
SummaryWrite Alpha User 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"