NCMBACL Class Reference

Inherits from	NSObject
Declared in	NCMBACL.h

Overview

NCMBACLクラスは、オブジェクトに対する読込書込権限を管理するクラスです。

NCMBObject毎にNCMBACLを持ち、ユーザのグループであるロールや特定の個別ユーザなどにも付与することができます。

例えば、全てのユーザに読込権限を与え、特定のユーザには読込権限に加え書込権限を与えるといったことができます。

Other Methods

`dicACL`

ACLの情報を辞書型で保持する

@property (nonatomic, strong) NSMutableDictionary *dicACL

Declared In

NCMBACL.h

`+ ACL`

NCMBACLのインスタンスを生成。デフォルトでは全ての権限が許可されている。

+ (NCMBACL *)ACL

Declared In

NCMBACL.h

`+ ACLWithUser:`

指定したユーザのみ読込書込権限が許可されたNCMBACLのインスタンスを生成。

+ (NCMBACL *)ACLWithUser:(NCMBUser *)user

Parameters

`user`	権限を設定するユーザ

Declared In

NCMBACL.h

`+ setDefaultACL:withAccessForCurrentUser:`

オブジェクト生成時にACLが指定されなかった場合のデフォルトACLをaclで指定したアクセス権限に設定する。 currentUserAccessがYESの場合は、さらにオブジェクトを生成したユーザーに読込書込権限を設定する。 NOの場合はaclで指定されたデフォルトACLが設定される。

+ (void)setDefaultACL:(NCMBACL *)acl withAccessForCurrentUser:(BOOL)currentUserAccess

Parameters

`acl`	デフォルトACLとして設定するNCMBACLインスタンス
`currentUserAccess`	オブジェクトを生成したユーザーへのアクセス権限をデフォルトACLに追加する設定

Declared In

NCMBACL.h

Public Access

`– setPublicReadAccess:`

パブリックな読込権限を設定する

- (void)setPublicReadAccess:(BOOL)allowed

Parameters

`allowed`	読込権限の設定（YES:許可／NO:許可取り消し）

Declared In

NCMBACL.h

`– isPublicReadAccess`

パブリックな読込権限の有無を取得する

- (BOOL)isPublicReadAccess

Return Value

YES:読み込み権限あり NO:読み込み権限なし

Declared In

NCMBACL.h

`– setPublicWriteAccess:`

パブリックな書込権限を設定

- (void)setPublicWriteAccess:(BOOL)allowed

Parameters

`allowed`	書込権限の設定（YES:許可／NO:許可取り消し）

Declared In

NCMBACL.h

`– isPublicWriteAccess`

パブリックな書込権限の有無を取得する

- (BOOL)isPublicWriteAccess

Return Value

YES:書き込み権限あり NO:書き込み権限なし

Declared In

NCMBACL.h

Role Access

`– isReadAccessForRoleWithName:`

指定した名前を持つロールの読込権限の有無を取得する

- (BOOL)isReadAccessForRoleWithName:(NSString *)name

Parameters

`name`	読込権限の有無を調べるロール名

Return Value

YES:読み込み権限あり NO:読み込み権限なし

Declared In

NCMBACL.h

`– setReadAccess:forRoleWithName:`

指定した名前を持つロールの読込権限を設定する

- (void)setReadAccess:(BOOL)allowed forRoleWithName:(NSString *)name

Parameters

`allowed`	読込権限の設定（YES:許可／NO:許可取り消し）
`name`	読込権限を設定するロール名

Declared In

NCMBACL.h

`– isWriteAccessForRoleWithName:`

指定した名前を持つロールの書込権限の有無を取得する

- (BOOL)isWriteAccessForRoleWithName:(NSString *)name

Parameters

`name`	書込権限の有無を調べるロール名

Return Value

YES:書き込み権限あり NO:書き込み権限なし

Declared In

NCMBACL.h

`– setWriteAccess:forRoleWithName:`

指定した名前を持つロールの書込権限を設定する

- (void)setWriteAccess:(BOOL)allowed forRoleWithName:(NSString *)name

Parameters

`allowed`	書込権限の設定（YES:許可／NO:許可取り消し）
`name`	書込権限を設定するロール名

Declared In

NCMBACL.h

`– isReadAccessForRole:`

指定したロールの読込権限の有無を取得する

- (BOOL)isReadAccessForRole:(NCMBRole *)role

Parameters

`role`	読込権限の有無を調べるロール

Return Value

YES:読み込み権限あり NO:読み込み権限なし

Declared In

NCMBACL.h

`– setReadAccess:forRole:`

指定したロールの読込権限を設定する

- (void)setReadAccess:(BOOL)allowed forRole:(NCMBRole *)role

Parameters

`allowed`	読込権限の設定（YES:許可／NO:許可取り消し）
`role`	読込権限を設定するロール

Declared In

NCMBACL.h

`– isWriteAccessForRole:`

指定したロールの書込権限の有無を取得する

- (BOOL)isWriteAccessForRole:(NCMBRole *)role

Parameters

`role`	書込権限の有無を調べるロール

Return Value

YES:書き込み権限あり NO:書き込み権限なし

Declared In

NCMBACL.h

`– setWriteAccess:forRole:`

指定したロールの書込権限を設定する

- (void)setWriteAccess:(BOOL)allowed forRole:(NCMBRole *)role

Parameters

`allowed`	書込権限の設定（YES:許可／NO:許可取り消し）
`role`	書込権限を設定するロール

Declared In

NCMBACL.h

User Access

`– setReadAccess:forUserId:`

指定したIDに対応するユーザーの読込権限を設定する

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

Parameters

`allowed`	読込権限の設定（YES:許可／NO:許可取り消し）
`userId`	読込権限を設定するユーザID

Declared In

NCMBACL.h

`– isReadAccessForUserId:`

指定したIDに対応するユーザーの読込権限の有無を取得する

- (BOOL)isReadAccessForUserId:(NSString *)userId

Parameters

`userId`	読込権限の有無を調べるユーザID

Return Value

YES:読み込み権限あり NO:読み込み権限なし

Declared In

NCMBACL.h

`– setWriteAccess:forUserId:`

指定したIDに対応するユーザーの書込権限を設定する

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

Parameters

`allowed`	書込権限の設定（YES:許可／NO:許可取り消し）
`userId`	書込権限を設定するユーザID

Declared In

NCMBACL.h

`– isWriteAccessForUserId:`

指定したIDに対応するユーザーの書込権限の有無を取得する

- (BOOL)isWriteAccessForUserId:(NSString *)userId

Parameters

`userId`	書込権限の有無を調べるユーザID

Return Value

YES:書き込み権限あり NO:書き込み権限なし

Declared In

NCMBACL.h

`– setReadAccess:forUser:`

指定したユーザーの読込権限を設定する

- (void)setReadAccess:(BOOL)allowed forUser:(NCMBUser *)user

Parameters

`allowed`	読込権限の設定（YES:許可／NO:許可取り消し）
`user`	読込権限を設定するユーザ

Declared In

NCMBACL.h

`– isReadAccessForUser:`

指定したユーザーの読込権限の有無を取得する

- (BOOL)isReadAccessForUser:(NCMBUser *)user

Parameters

`user`	読込権限の有無を調べるユーザ

Return Value

YES:読み込み権限あり NO:読み込み権限なし

Declared In

NCMBACL.h

`– setWriteAccess:forUser:`

指定したユーザーの書込権限を設定

- (void)setWriteAccess:(BOOL)allowed forUser:(NCMBUser *)user

Parameters

`allowed`	書込権限の設定（YES:許可／NO:許可取り消し）
`user`	書込権限を設定するユーザ

Declared In

NCMBACL.h

`– isWriteAccessForUser:`

指定したユーザーの書込権限の有無を取得

- (BOOL)isWriteAccessForUser:(NCMBUser *)user

Parameters

`user`	書込権限の有無を調べるユーザ

Return Value

YES:書き込み権限あり NO:書き込み権限なし

Declared In

NCMBACL.h