QueueSASPermissions class
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.
Properties
| add | Specifies Add access granted. |
| process | Specifies Process access granted. |
| read | Specifies Read access granted. |
| update | Specifies Update access granted. |
Methods
| parse(string) | Creates a QueueSASPermissions from the specified permissions string. This method will throw an Error if it encounters a character that does not correspond to a valid permission. |
| to |
Converts the given permissions to a string. Using this method will guarantee the permissions are in an order accepted by the service. |
Property Details
add
Specifies Add access granted.
add: booleanProperty Value
boolean
process
Specifies Process access granted.
process: booleanProperty Value
boolean
read
Specifies Read access granted.
read: booleanProperty Value
boolean
update
Specifies Update access granted.
update: booleanProperty Value
boolean
Method Details
parse(string)
Creates a QueueSASPermissions from the specified permissions string. This method will throw an Error if it encounters a character that does not correspond to a valid permission.
static function parse(permissions: string): QueueSASPermissionsParameters
- permissions
-
string
Returns
toString()
Converts the given permissions to a string. Using this method will guarantee the permissions are in an order accepted by the service.
function toString(): stringReturns
string
A string which represents the QueueSASPermissions