Class KiiACLEntry
Represents a KiiACLEntry object
Defined in: KiiSDK.js.
Constructor Attributes | Constructor Name and Description |
---|---|
Method Attributes | Method Name and Description |
---|---|
<static> |
KiiACLEntry.entryWithSubject(Subject, action)
Create a KiiACLEntry object with a subject and action
The entry will not be applied on the server until the KiiACL object is
explicitly saved.
|
Get the action that is being permitted/restricted in this entry
|
|
getGrant()
Get whether or not the action is being permitted to the subject
|
|
Get the subject that is being permitted/restricted in this entry
|
|
setAction(value)
The action that is being permitted/restricted.
|
|
setGrant(value)
Set whether or not the action is being permitted to the subject
|
|
setSubject(subject)
Set the subject to which the action/grant is being applied
|
Method Detail
<static>
KiiACLEntry.entryWithSubject(Subject, action)
Create a KiiACLEntry object with a subject and action
The entry will not be applied on the server until the KiiACL object is
explicitly saved. This method simply returns a working KiiACLEntry with
a specified subject and action.
- Parameters:
- {KiiGroup|KiiUser|KiiAnyAuthenticatedUser|KiiAnonymousUser|KiiThing} Subject
- to which the action/grant is being applied
- {KiiACLAction} action
- One of the specified KiiACLAction values the permissions is being applied to
- Throws:
- {InvalidACLSubject}
- If specified subject is invalid.
- {InvalidACLAction}
- If the specified action is invalid.
- Returns:
- A KiiACLEntry object with the specified attributes
{KiiACLAction}
getAction()
Get the action that is being permitted/restricted in this entry
- Returns:
- {KiiACLAction}
{Boolean}
getGrant()
Get whether or not the action is being permitted to the subject
- Returns:
- {Boolean}
Get the subject that is being permitted/restricted in this entry
setAction(value)
The action that is being permitted/restricted. Possible values:
KiiACLAction.KiiACLBucketActionCreateObjects,
KiiACLAction.KiiACLBucketActionQueryObjects,
KiiACLAction.KiiACLBucketActionDropBucket,
KiiACLAction.KiiACLBucketActionReadObjects,
KiiACLAction.KiiACLObjectActionRead,
KiiACLAction.KiiACLObjectActionWrite,
KiiACLAction.KiiACLSubscribeToTopic,
KiiACLAction.KiiACLSendMessageToTopic
KiiACLAction.KiiACLBucketActionCreateObjects,
KiiACLAction.KiiACLBucketActionQueryObjects,
KiiACLAction.KiiACLBucketActionDropBucket,
KiiACLAction.KiiACLBucketActionReadObjects,
KiiACLAction.KiiACLObjectActionRead,
KiiACLAction.KiiACLObjectActionWrite,
KiiACLAction.KiiACLSubscribeToTopic,
KiiACLAction.KiiACLSendMessageToTopic
- Parameters:
- {KiiACLAction} value
- The action being permitted/restricted
- Throws:
- {InvalidACLAction}
- If the value is not one of the permitted values
setGrant(value)
Set whether or not the action is being permitted to the subject
- Parameters:
- {Boolean} value
- true if the action is permitted, false otherwise
- Throws:
- {InvalidACLGrant}
- If the value is not a boolean type
setSubject(subject)
Set the subject to which the action/grant is being applied
- Parameters:
- {KiiGroup|KiiUser|KiiAnyAuthenticatedUser|KiiAnonymousUser|KiiThing} subject
- instance.
- Throws:
- {InvalidACLSubject}
- If the value is not one of the permitted values