DocumentEncryptOpts

public class DocumentEncryptOpts : SdkObject

Parameters that can be provided when encrypting a new document.

Document IDs must be unique to the segment. If no ID is provided, one will be generated for it. If no name is provided, the document’s name will be left empty. Neither the document’s ID nor name will be encrypted.

  • Constructs a DocumentEncryptOpts with common values.

    The document will have a generated ID and no name. Only the document’s author will be able to read and decrypt it.

    Declaration

    Swift

    public convenience init()
  • Constructs a DocumentEncryptOpts.

    Declaration

    Swift

    public convenience init(
        id: DocumentId?,
        documentName: DocumentName?,
        grantToAuthor: Bool,
        userGrants: [UserId],
        groupGrants: [GroupId],
        policyGrant: PolicyGrant?
    )

    Parameters

    id

    ID to use for the document.

    documentName

    Name to use for the document.

    grantToAuthor

    true if the calling user should have access to decrypt this document

    userGrants

    List of users that should have access to read and decrypt this document

    groupGrants

    List of groups that should have access to read and decrypt this document

    policyGrant

    Policy to determine which users and groups will have access to read and decrypt this document.