Class KiiACL

Represents a KiiACL object

Hierarchy

KiiACL

Index

Methods

Methods

listACLEntries

listACLEntries(): Promise<KiiACLEntry[]>

- Defined in src/acl.ts:57
Get the list of active ACLs associated with this object from the server
example
```
let acl = . . .; // a KiiACL object
acl.listACLEntries().then(theEntries => {
  // do something
}).catch(error => {
  // do something with the error response
});
```
Returns Promise<KiiACLEntry[]>
return promise object.
- fulfill callback function: function(result). result is an array of KiiACLEntry instances.
- reject callback function: function(error). error is an Error instance.
  - error.target is the KiiACL instance which this method was called on.
  - error.message

putACLEntry

putACLEntry(entry: KiiACLEntry): void

- Defined in src/acl.ts:103
Add a KiiACLEntry to the local object, if not already present. This does not explicitly grant any permissions, which should be done through the KiiACLEntry itself. This method simply adds the entry to the local ACL object so it can be saved to the server.
example
```
let aclEntry = . . .; // a KiiACLEntry object
let acl = . . .; // a KiiACL object
acl.putACLEntry(aclEntry);
```
Parameters
- entry: KiiACLEntry
  
  The KiiACLEntry to add
Returns void

removeACLEntry

removeACLEntry(entry: KiiACLEntry): KiiACL

- Defined in src/acl.ts:119
Remove a KiiACLEntry to the local object. This does not explicitly revoke any permissions, which should be done through the KiiACLEntry itself. This method simply removes the entry from the local ACL object and will not be saved to the server.
example
```
let aclEntry = . . .; // a KiiACLEntry object
let acl = . . .; // a KiiACL object
acl.removeACLEntry(aclEntry);
```
Parameters
- entry: KiiACLEntry
  
  The KiiACLEntry to remove
Returns KiiACL

save

save(): Promise<KiiACL>

- Defined in src/acl.ts:148
Save the list of ACLEntry objects associated with this ACL object to the server
example
```
let acl = . . .; // a KiiACL object
acl.save().then(() => {
  // do something with the saved acl
}).catch(error => {
  let theACL = error.target;
  let anErrorString = error.message;
  // do something with the error response
});
```
Returns Promise<KiiACL>
return promise object.
- fulfill callback function: function(theSavedACL). theSavedACL is KiiACL instance.
- reject callback function: function(error). error is an Error instance.
  - error.target is the KiiACL instance which this method was called on.
  - error.message

Generated using TypeDoc