BuiltACL Class Reference

Inherits from NSObject
Declared in BuiltACL.h

Disable ACL

– disableACL:

Disables ACL on a particular BuiltObject.

- (void)disableACL:(BOOL)disable

Parameters

disable

When true disables ACL on BuiltObject, ables otherwise.

Discussion

 //'blt5d4sample2633b' is a dummy Application API key
 //Obj-C
 BuiltApplication *builtApplication = [Built applicationWithAPIKey:@"blt5d4sample2633b"];
 BuiltACL *aclObject = [builtApplication acl];
 [aclObject disableACL:YES];

 //Swift
 var builtApplication:BuiltApplication = Built.applicationWithAPIKey("blt5d4sample2633b")
 var aclObject:BuiltACL = builtApplication.acl()
 aclObject.disableACL(true)

Declared In

BuiltACL.h

– isDisabled

States whether ACL is enabled or disabled on BuiltObject.

- (BOOL)isDisabled

Return Value

Returns true/YES if ACL is enabled, false/NO otherwise.

Discussion

 //'blt5d4sample2633b' is a dummy Application API key
 //Obj-C
 BuiltApplication *builtApplication = [Built applicationWithAPIKey:@"blt5d4sample2633b"];
 BuiltACL *aclObject = [builtApplication acl];
 if ([aclObject isDisabled]) {
    // ACL enable
 } else {
    // ACL disable
 }

 //Swift
 var builtApplication:BuiltApplication = Built.applicationWithAPIKey("blt5d4sample2633b")
 var aclObject:BuiltACL = builtApplication.acl()
 if (aclObject.isDisabled) {
    // ACL enable
 } else {
    // ACL disable
 }

Declared In

BuiltACL.h

Controlling Public Access

– setPublicReadAccess:

Set whether the others is allowed to read this object.

- (void)setPublicReadAccess:(BOOL)allowed

Parameters

allowed

Whether read access is allowed (YES/true or NO/false).

Discussion

//'blt5d4sample2633b' is a dummy Application API key
//Obj-C
BuiltApplication *builtApplication = [Built applicationWithAPIKey:@"blt5d4sample2633b"];
BuiltACL *aclObject = [builtApplication acl];
[aclObject setPublicReadAccess:YES];

//Swift
var builtApplication:BuiltApplication = Built.applicationWithAPIKey("blt5d4sample2633b")
var aclObject:BuiltACL = builtApplication.acl()
aclObject.setPublicReadAccess(true)

Declared In

BuiltACL.h

– getPublicReadAccess

Gets whether the others is allowed to read this object.

- (BOOL)getPublicReadAccess

Return Value

Returns YES if read access is granted to others. NO otherwise.

Discussion

//'blt5d4sample2633b' is a dummy Application API key
//Obj-C
BuiltApplication *builtApplication = [Built applicationWithAPIKey:@"blt5d4sample2633b"];
BuiltACL *aclObject = [builtApplication acl];
if ([aclObject getPublicReadAccess]) {
   // ACL public read access
}

//Swift
var builtApplication:BuiltApplication = Built.applicationWithAPIKey("blt5d4sample2633b")
var aclObject:BuiltACL = builtApplication.acl()
if (aclObject.getPublicReadAccess()) {
    // ACL public read access
}

Declared In

BuiltACL.h

– setPublicWriteAccess:

Set whether the others is allowed to write this object.

- (void)setPublicWriteAccess:(BOOL)allowed

Parameters

allowed

Whether write access is allowed (YES/true or NO/false).

Discussion

//'blt5d4sample2633b' is a dummy Application API key
//Obj-C
BuiltApplication *builtApplication = [Built applicationWithAPIKey:@"blt5d4sample2633b"];
BuiltACL *aclObject = [builtApplication acl];
[aclObject setPublicWriteAccess:YES];

//Swift
var builtApplication:BuiltApplication = Built.applicationWithAPIKey("blt5d4sample2633b")
var aclObject:BuiltACL = builtApplication.acl()
aclObject.setPublicWriteAccess(true)

Declared In

BuiltACL.h

– getPublicWriteAccess

Gets whether the others is allowed to write this object.

- (BOOL)getPublicWriteAccess

Return Value

Returns YES if write access is granted to others. NO otherwise.

Discussion

//'blt5d4sample2633b' is a dummy Application API key
//Obj-C
BuiltApplication *builtApplication = [Built applicationWithAPIKey:@"blt5d4sample2633b"];
BuiltACL *aclObject = [builtApplication acl];
if([aclObject getPublicWriteAccess]) {
    //ACL public write access is granted
}

//Swift
var builtApplication:BuiltApplication = Built.applicationWithAPIKey("blt5d4sample2633b")
var aclObject:BuiltACL = builtApplication.acl()
if (aclObject.getPublicWriteAccess()) {
    //ACL public write access is granted
}

Declared In

BuiltACL.h

– setPublicDeleteAccess:

Set whether the others is allowed to delete this object.

- (void)setPublicDeleteAccess:(BOOL)allowed

Parameters

allowed

Whether delete access is allowed (YES/true or NO/false).

Discussion

//'blt5d4sample2633b' is a dummy Application API key
//Obj-C
BuiltApplication *builtApplication = [Built applicationWithAPIKey:@"blt5d4sample2633b"];
BuiltACL *aclObject = [builtApplication acl];
[aclObject setPublicDeleteAccess:YES];

//Swift
var builtApplication:BuiltApplication = Built.applicationWithAPIKey("blt5d4sample2633b")
var aclObject:BuiltACL = builtApplication.acl()
aclObject.setPublicDeleteAccess(true)

Declared In

BuiltACL.h

– getPublicDeleteAccess

Gets whether the others is allowed to delete this object.

- (BOOL)getPublicDeleteAccess

Return Value

Returns YES if delete access is granted to others. NO otherwise.

Discussion

//'blt5d4sample2633b' is a dummy Application API key
//Obj-C
BuiltApplication *builtApplication = [Built applicationWithAPIKey:@"blt5d4sample2633b"];
BuiltACL *aclObject = [builtApplication acl];
if ([aclObject getPublicDeleteAccess]) {
    // ACL public delete access
}

//Swift
var builtApplication:BuiltApplication = Built.applicationWithAPIKey("blt5d4sample2633b")
var aclObject:BuiltACL = builtApplication.acl()
if (aclObject.getPublicDeleteAccess()) {
    // ACL public delete access
}

Declared In

BuiltACL.h

Controlling Access Per-User

– setReadAccess:forUserId:

Set whether the given user id is allowed to read this object.

- (void)setReadAccess:(BOOL)allowed forUserId:(NSString *)userId

Parameters

allowed

Whether read access is allowed (YES/true or NO/false).

userId

The user id to assign access.

Discussion

//'blt5d4sample2633b' is a dummy Application API key
//'bltba9sampleuser41' is a uid of an object of inbuilt Application User class

//Obj-C
BuiltApplication *builtApplication = [Built applicationWithAPIKey:@"blt5d4sample2633b"];
BuiltACL *aclObject = [builtApplication acl];
[aclObject setReadAccess:YES forUserId:@"bltba9sampleuser41"];

//Swift
var builtApplication:BuiltApplication = Built.applicationWithAPIKey("blt5d4sample2633b")
var aclObject:BuiltACL = builtApplication.acl()
aclObject.setReadAccess(true, forUserId:"bltba9sampleuser41")

Declared In

BuiltACL.h

– getReadAccessForUserId:

Gets whether the given user id is explicitly allowed to read this object. Even if this returns NO, the user may still be able to access it if getPublicReadAccess returns YES or if the user belongs to a role that has access.

- (BOOL)getReadAccessForUserId:(NSString *)userId

Parameters

userId

User ID for which to check read access.

Return Value

Returns YES if read access is granted to others. NO otherwise.

Discussion

//'blt5d4sample2633b' is a dummy Application API key
//'bltba9sampleuser41' is a uid of an object of inbuilt Application User class

//Obj-C
BuiltApplication *builtApplication = [Built applicationWithAPIKey:@"blt5d4sample2633b"];
BuiltACL *aclObject = [builtApplication acl];
if ([aclObject getReadAccessForUserId:@"bltba9sampleuser41"]) {
    // Read access
} else {
    // No Read access
}

//Swift
var builtApplication:BuiltApplication = Built.applicationWithAPIKey("blt5d4sample2633b")
var aclObject:BuiltACL = builtApplication.acl()
if (aclObject.getReadAccessForUserId("bltba9sampleuser41")) {
    // Read access
} else {
    // No Read access
}

Declared In

BuiltACL.h

– setWriteAccess:forUserId:

Set whether the given user id is allowed to write this object.

- (void)setWriteAccess:(BOOL)allowed forUserId:(NSString *)userId

Parameters

allowed

Whether write access is allowed (YES/true or NO/false).

userId

The user id to assign access.

Discussion

//'blt5d4sample2633b' is a dummy Application API key
//'bltba9sampleuser41' is a uid of an object of inbuilt Application User class

//Obj-C
BuiltApplication *builtApplication = [Built applicationWithAPIKey:@"blt5d4sample2633b"];
BuiltACL *aclObject = [builtApplication acl];
[aclObject setWriteAccess:YES forUserId:@"bltba9sampleuser41"]

//Swift
var builtApplication:BuiltApplication = Built.applicationWithAPIKey("blt5d4sample2633b")
var aclObject:BuiltACL = builtApplication.acl()
aclObject.setWriteAccess(true, forUserId:"bltba9sampleuser41")

Declared In

BuiltACL.h

– getWriteAccessForUserId:

Gets whether the given user id is explicitly allowed to write this object. Even if this returns NO, the user may still be able to access it if getPublicWriteAccess returns YES or if the user belongs to a role that has access.

- (BOOL)getWriteAccessForUserId:(NSString *)userId

Parameters

userId

User ID for which to check write access.

Return Value

Returns YES if write access is granted to others. NO otherwise.

Discussion

//'blt5d4sample2633b' is a dummy Application API key
//'bltba9sampleuser41' is a uid of an object of inbuilt Application User class

//Obj-C
BuiltApplication *builtApplication = [Built applicationWithAPIKey:@"blt5d4sample2633b"];
BuiltACL *aclObject = [builtApplication acl];
if ([aclObject getWriteAccessForUserId:@"bltba9sampleuser41"]) {
    //Write access for this user
} else {
    //No write access
}

//Swift
var builtApplication:BuiltApplication = Built.applicationWithAPIKey("blt5d4sample2633b")
var aclObject:BuiltACL = builtApplication.acl()
if (aclObject.getWriteAccessForUserId("bltba9sampleuser41")) {
    //Write access for this user
} else {
    //No write access
}

Declared In

BuiltACL.h

– setDeleteAccess:forUserId:

Set whether the given user id is allowed to delete this object.

- (void)setDeleteAccess:(BOOL)allowed forUserId:(NSString *)userId

Parameters

allowed

Whether delete access is allowed (YES/true or NO/false).

userId

The user id to assign access.

Discussion

//'blt5d4sample2633b' is a dummy Application API key
//'bltba9sampleuser41' is a uid of an object of inbuilt Application User class

//Obj-C
BuiltApplication *builtApplication = [Built applicationWithAPIKey:@"blt5d4sample2633b"];
BuiltACL *aclObject = [builtApplication acl];
[aclObject setDeleteAccess:YES forUserId:@"bltba9sampleuser41"];

//Swift
var builtApplication:BuiltApplication = Built.applicationWithAPIKey("blt5d4sample2633b")
var aclObject:BuiltACL = builtApplication.acl()
aclObject.setDeleteAccess(true , forUserId:"bltba9sampleuser41")

Declared In

BuiltACL.h

– getDeleteAccessForUserId:

Gets whether the given user id is explicitly allowed to delete this object. Even if this returns NO, the user may still be able to access it if getPublicDeleteAccess returns YES or if the user belongs to a role that has access.

- (BOOL)getDeleteAccessForUserId:(NSString *)userId

Parameters

userId

User ID for which to check delete access.

Return Value

Returns YES if delete access is granted to others. NO otherwise.

Discussion

//'blt5d4sample2633b' is a dummy Application API key
//'bltba9sampleuser41' is a uid of an object of inbuilt Application User class


//Obj-C
BuiltApplication *builtApplication = [Built applicationWithAPIKey:@"blt5d4sample2633b"];
BuiltACL *aclObject = [builtApplication acl];
if ([aclObject getDeleteAccessForUserId:@"bltba9sampleuser41"]) {
    //Delete access allow for this user
} else {
    //Delete not allow
}

//Swift
var builtApplication:BuiltApplication = Built.applicationWithAPIKey("blt5d4sample2633b")
var aclObject:BuiltACL = builtApplication.acl()
if (aclObject.getDeleteAccessForUserId("bltba9sampleuser41")) {
    //Delete access allow for this user");
} else {
    //Delete not allow
}

Declared In

BuiltACL.h

Controlling Role Access

– getRoleReadAccess:

Gets whether the users with given role are explicitly allowed to read this object. Even if this returns NO, the user may still be able to access it if getPublicReadAccess returns YES or if the user belongs to a role that has access.

- (BOOL)getRoleReadAccess:(NSString *)role_uid

Parameters

role_uid

Role UID for which to check read access.

Return Value

Returns YES if read access is granted to users with role. NO otherwise.

Discussion

//'blt5d4sample2633b' is a dummy Application API key
//'bltbg2samplerole84' is a uid of an object of inbuilt Application User class


//Obj-C
BuiltApplication *builtApplication = [Built applicationWithAPIKey:@"blt5d4sample2633b"];
BuiltACL *aclObject = [builtApplication acl];
if ([aclObject getRoleReadAccess:@"bltbg2samplerole84"]) {
    //Role read allow
} else {
    //Role read not allow
}

//Swift
var builtApplication:BuiltApplication = Built.applicationWithAPIKey("blt5d4sample2633b")
var aclObject:BuiltACL = builtApplication.acl()
if (aclObject.getRoleReadAccess("bltbg2samplerole84")) {
    //Role read allow
} else {
    //Role read not allow
}

Declared In

BuiltACL.h

– getRoleWriteAccess:

Gets whether the users with given role are explicitly allowed to write this object. Even if this returns NO, the user may still be able to access it if getPublicWriteAccess returns YES or if the user belongs to a role that has access.

- (BOOL)getRoleWriteAccess:(NSString *)role_uid

Parameters

role_uid

Role UID for which to check write access.

Return Value

Returns YES if write access is granted to users with role. NO otherwise.

Discussion

//'blt5d4sample2633b' is a dummy Application API key
//'bltbg2samplerole84' is a uid of an object of inbuilt Application User class

//Obj-C
BuiltApplication *builtApplication = [Built applicationWithAPIKey:@"blt5d4sample2633b"];
BuiltACL *aclObject = [builtApplication acl];
if ([aclObject getRoleWriteAccess:@"bltbg2samplerole84"]) {
    //Role write allow
} else {
    //Role write not allow
}

//Swift
var builtApplication:BuiltApplication = Built.applicationWithAPIKey("blt5d4sample2633b")
var aclObject:BuiltACL = builtApplication.acl()
if (aclObject.getRoleWriteAccess("bltbg2samplerole84")) {
    //Role write allow
} else {
    //Role write not allow
}

Declared In

BuiltACL.h

– getRoleDeleteAccess:

Gets whether the users with given role are explicitly allowed to delete this object. Even if this returns NO, the user may still be able to access it if getPublicDeleteAccess returns YES or if the user belongs to a role that has access.

- (BOOL)getRoleDeleteAccess:(NSString *)role_uid

Parameters

role_uid

Role UID for which to check delete access.

Return Value

Returns YES if delete access is granted to users with role. NO otherwise.

Discussion

//'blt5d4sample2633b' is a dummy Application API key
//'bltbg2samplerole84' is a uid of an object of inbuilt Application User class

//Obj-C
BuiltApplication *builtApplication = [Built applicationWithAPIKey:@"blt5d4sample2633b"];
BuiltACL *aclObject = [builtApplication acl];
if ([aclObject getRoleDeleteAccess:@"bltbg2samplerole84"]) {
    // Role delete allow
} else {
    // Role delete not allow
}

//Swift
var builtApplication:BuiltApplication = Built.applicationWithAPIKey("blt5d4sample2633b")
var aclObject:BuiltACL = builtApplication.acl()
if (aclObject.getRoleDeleteAccess("bltbg2samplerole84")) {
    // Role delete allow
} else {
    // Role delete not allow
}

Declared In

BuiltACL.h

– setRoleReadAccess:forRoleUID:

Set whether the given users with role_uid are allowed to delete this object.

- (void)setRoleReadAccess:(BOOL)allowed forRoleUID:(NSString *)role_uid

Parameters

allowed

Whether read access is allowed (YES/true or NO/false).

role_uid

The role uid to assign access.

Discussion

//'blt5d4sample2633b' is a dummy Application API key
//'bltbg2samplerole84' is a uid of an object of inbuilt Application User class

//Obj-C
BuiltApplication *builtApplication = [Built applicationWithAPIKey:@"blt5d4sample2633b"];
BuiltACL *aclObject = [builtApplication acl];
[aclObject setRoleReadAccess:YES forRoleUID:@"bltbg2samplerole84"];

//Swift
var builtApplication:BuiltApplication = Built.applicationWithAPIKey("blt5d4sample2633b")
var aclObject:BuiltACL = builtApplication.acl()
aclObject.setRoleReadAccess(true, forRoleUID:"bltbg2samplerole84")

Declared In

BuiltACL.h

– setRoleWriteAccess:forRoleUID:

Set whether the given users with role_uid are allowed to write this object.

- (void)setRoleWriteAccess:(BOOL)allowed forRoleUID:(NSString *)role_uid

Parameters

allowed

Whether write access is allowed (YES/true or NO/false).

role_uid

The role uid to assign access.

Discussion

//'blt5d4sample2633b' is a dummy Application API key
//'bltbg2samplerole84' is a uid of an object of inbuilt Application User class

//Obj-C
BuiltApplication *builtApplication = [Built applicationWithAPIKey:@"blt5d4sample2633b"];
BuiltACL *aclObject = [builtApplication acl];
[aclObject  setRoleWriteAccess:YES forRoleUID:@"bltbg2samplerole84"];

//Swift
var builtApplication:BuiltApplication = Built.applicationWithAPIKey("blt5d4sample2633b")
var aclObject:BuiltACL = builtApplication.acl()
aclObject.setRoleWriteAccess(true, forRoleUID:"bltbg2samplerole84")

Declared In

BuiltACL.h

– setRoleDeleteAccess:forRoleUID:

Set whether the given users with role_uid are allowed to delete this object.

- (void)setRoleDeleteAccess:(BOOL)allowed forRoleUID:(NSString *)role_uid

Parameters

allowed

Whether delete access is allowed (YES/true or NO/false).

role_uid

The role uid to assign access.

Discussion

 //'blt5d4sample2633b' is a dummy Application API key
 //'bltbg2samplerole84' is a uid of an object of inbuilt Application User class

//Obj-C
BuiltApplication *builtApplication = [Built applicationWithAPIKey:@"blt5d4sample2633b"];
BuiltACL *aclObject = [builtApplication acl];
[aclObject setRoleDeleteAccess:YES forRoleUID:@"bltbg2samplerole84"];

//Swift
var builtApplication:BuiltApplication = Built.applicationWithAPIKey("blt5d4sample2633b")
var aclObject:BuiltACL = builtApplication.acl()
aclObject.setRoleDeleteAccess(true, forRoleUID:"bltbg2samplerole84")

Declared In

BuiltACL.h

Controlling Anonymous Access

– setAnonymousReadAccess:

Set whether the anonymous users is allowed to read this object.

- (void)setAnonymousReadAccess:(BOOL)allowed

Parameters

allowed

Whether read access is allowed (YES/true or NO/false).

Discussion

 //'blt5d4sample2633b' is a dummy Application API key
 //Obj-C
 BuiltApplication *builtApplication = [Built applicationWithAPIKey:@"blt5d4sample2633b"];
 BuiltACL *aclObject = [builtApplication acl];
 [aclObject setAnonymousReadAccess:YES];

 //Swift
 var builtApplication:BuiltApplication = Built.applicationWithAPIKey("blt5d4sample2633b")
 var aclObject:BuiltACL = builtApplication.acl()
 aclObject.setAnonymousReadAccess(true)

Declared In

BuiltACL.h

– getAnonymousReadAccess

Gets whether the anonymous users is allowed to read this object.

- (BOOL)getAnonymousReadAccess

Return Value

Returns true if read access is granted to others. false otherwise.

Discussion

 //'blt5d4sample2633b' is a dummy Application API key
 //Obj-C
 BuiltApplication *builtApplication = [Built applicationWithAPIKey:@"blt5d4sample2633b"];
 BuiltACL *aclObject = [builtApplication acl];
 if ([aclObject getPublicReadAccess]) {
    // ACL public read access
 }

 //Swift
 var builtApplication:BuiltApplication = Built.applicationWithAPIKey("blt5d4sample2633b")
 var aclObject:BuiltACL = builtApplication.acl()
 if (aclObject.getPublicReadAccess()) {
    // ACL public read access
 }

Declared In

BuiltACL.h

– setAnonymousWriteAccess:

Set whether the anonymous users is allowed to write this object.

- (void)setAnonymousWriteAccess:(BOOL)allowed

Parameters

allowed

Whether write access is allowed (YES/true or NO/false).

Discussion

 //'blt5d4sample2633b' is a dummy Application API key
 //Obj-C
 BuiltApplication *builtApplication = [Built applicationWithAPIKey:@"blt5d4sample2633b"];
 BuiltACL *aclObject = [builtApplication acl];
 [aclObject setAnonymousWriteAccess:YES];

 //Swift
 var builtApplication:BuiltApplication = Built.applicationWithAPIKey("blt5d4sample2633b")
 var aclObject:BuiltACL = builtApplication.acl()
 aclObject.setAnonymousWriteAccess(true)

Declared In

BuiltACL.h

– getAnonymousWriteAccess

Gets whether the anonymous users is allowed to write this object.

- (BOOL)getAnonymousWriteAccess

Return Value

Returns true if write access is granted to others. false otherwise.

Discussion

 //'blt5d4sample2633b' is a dummy Application API key
 //Obj-C
 BuiltApplication *builtApplication = [Built applicationWithAPIKey:@"blt5d4sample2633b"];
 BuiltACL *aclObject = [builtApplication acl];
 if ([aclObject getAnonymousWriteAccess]) {
    // ACL anonymous write access
 }

 //Swift
 var builtApplication:BuiltApplication = Built.applicationWithAPIKey("blt5d4sample2633b")
 var aclObject:BuiltACL = builtApplication.acl()
 if (aclObject.getAnonymousWriteAccess()) {
    // ACL anonymous write access
 }

Declared In

BuiltACL.h

– setAnonymousDeleteAccess:

Set whether the anonymous users is allowed to delete this object.

- (void)setAnonymousDeleteAccess:(BOOL)allowed

Parameters

allowed

Whether delete access is allowed (YES/true or NO/false).

Discussion

 //'blt5d4sample2633b' is a dummy Application API key
 //Obj-C
 BuiltApplication *builtApplication = [Built applicationWithAPIKey:@"blt5d4sample2633b"];
 BuiltACL *aclObject = [builtApplication acl];
 [aclObject setAnonymousDeleteAccess:YES];

 //Swift
 var builtApplication:BuiltApplication = Built.applicationWithAPIKey("blt5d4sample2633b")
 var aclObject:BuiltACL = builtApplication.acl()
 aclObject.setAnonymousDeleteAccess(true)

Declared In

BuiltACL.h

– getAnonymousDeleteAccess

Gets whether the anonymous users is allowed to delete this object.

- (BOOL)getAnonymousDeleteAccess

Return Value

Returns true if delete access is granted to others. false otherwise.

Discussion

 //'blt5d4sample2633b' is a dummy Application API key
 //Obj-C
 BuiltApplication *builtApplication = [Built applicationWithAPIKey:@"blt5d4sample2633b"];
 BuiltACL *aclObject = [builtApplication acl];
 if ([aclObject getAnonymousDeleteAccess]) {
    // ACL anonymous delete access
 }

 //Swift
 var builtApplication:BuiltApplication = Built.applicationWithAPIKey("blt5d4sample2633b")
 var aclObject:BuiltACL = builtApplication.acl()
 if (aclObject.getAnonymousDeleteAccess()) {
    // ACL anonymous delete access
 }

Declared In

BuiltACL.h