Options
All
  • Public
  • Public/Protected
  • All
Menu

Class FileSASPermissions

Package version

ONLY AVAILABLE IN NODE.JS RUNTIME.

This is a helper class to construct a string representing the permissions granted by a ServiceSAS to a file. Setting a value to true means that any SAS which uses these permissions will grant permissions for that operation. Once all the values are set, this should be serialized with toString and set as the permissions field on a FileSASSignatureValues object. It is possible to construct the permissions string without this class, but the order of the permissions is particular and this class guarantees correctness.

export
class

FileSASPermissions

Hierarchy

  • FileSASPermissions

Index

Properties

Methods

Properties

create

create: boolean = false

Specifies Create access granted.

type

{boolean}

memberof

FileSASPermissions

delete

delete: boolean = false

Specifies Delete access granted.

type

{boolean}

memberof

FileSASPermissions

read

read: boolean = false

Specifies Read access granted.

type

{boolean}

memberof

FileSASPermissions

write

write: boolean = false

Specifies Write access granted.

type

{boolean}

memberof

FileSASPermissions

Methods

toString

  • toString(): string
  • Converts the given permissions to a string. Using this method will guarantee the permissions are in an order accepted by the service.

    memberof

    FileSASPermissions

    Returns string

    A string which represents the FileSASPermissions

Static parse

Generated using TypeDoc