Options
All
  • Public
  • Public/Protected
  • All
Menu

Class QueueSASPermissions

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 Queue. 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 QueueSASSignatureValues 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

QueueSASPermissions

Hierarchy

  • QueueSASPermissions

Index

Properties

Methods

Properties

add

add: boolean = false

Specifies Add access granted.

type

{boolean}

memberof

QueueSASPermissions

process

process: boolean = false

Specifies Process access granted.

type

{boolean}

memberof

QueueSASPermissions

read

read: boolean = false

Specifies Read access granted.

type

{boolean}

memberof

QueueSASPermissions

update

update: boolean = false

Specifies Update access granted.

type

{boolean}

memberof

QueueSASPermissions

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

    QueueSASPermissions

    Returns string

    A string which represents the QueueSASPermissions

Static parse

Generated using TypeDoc