initial

Parse.framework/Versions/1.2.13/Headers/PFRole.h

@@ -0,0 +1,98 @@
+//
+//  PFRole.h
+//  Parse
+//
+//  Created by David Poll on 5/17/12.
+//  Copyright (c) 2012 Parse Inc. All rights reserved.
+//
+
+#import <Foundation/Foundation.h>
+
+#import "PFObject.h"
+#import "PFSubclassing.h"
+
+/*!
+ Represents a Role on the Parse server. PFRoles represent groupings
+ of PFUsers for the purposes of granting permissions (e.g. specifying a
+ PFACL for a PFObject). Roles are specified by their sets of child users
+ and child roles, all of which are granted any permissions that the
+ parent role has.<br />
+ <br />
+ Roles must have a name (which cannot be changed after creation of the role),
+ and must specify an ACL.
+ */
+@interface PFRole : PFObject<PFSubclassing>
+
+#pragma mark Creating a New Role
+
+/** @name Creating a New Role */
+
+/*!
+ Constructs a new PFRole with the given name. If no default ACL has been
+ specified, you must provide an ACL for the role.
+ 
+ @param name The name of the Role to create.
+ */
+- (id)initWithName:(NSString *)name;
+
+/*!
+ Constructs a new PFRole with the given name.
+ 
+ @param name The name of the Role to create.
+ @param acl The ACL for this role. Roles must have an ACL.
+ */
+- (id)initWithName:(NSString *)name acl:(PFACL *)acl;
+
+/*!
+ Constructs a new PFRole with the given name. If no default ACL has been
+ specified, you must provide an ACL for the role.
+ 
+ @param name The name of the Role to create.
+ */
++ (instancetype)roleWithName:(NSString *)name;
+
+/*!
+ Constructs a new PFRole with the given name.
+ 
+ @param name The name of the Role to create.
+ @param acl The ACL for this role. Roles must have an ACL.
+ */
++ (instancetype)roleWithName:(NSString *)name acl:(PFACL *)acl;
+
+#pragma mark -
+#pragma mark Role-specific Properties
+
+/** @name Role-specific Properties */
+
+/*!
+ Gets or sets the name for a role. This value must be set before the role
+ has been saved to the server, and cannot be set once the role has been
+ saved.<br />
+ <br />
+ A role's name can only contain alphanumeric characters, _, -, and spaces.
+ */
+@property (nonatomic, copy) NSString *name;
+
+/*!
+ Gets the PFRelation for the PFUsers that are direct children of this role.
+ These users are granted any privileges that this role has been granted
+ (e.g. read or write access through ACLs). You can add or remove users from
+ the role through this relation.
+ */
+@property (nonatomic, readonly, retain) PFRelation *users;
+
+/*!
+ Gets the PFRelation for the PFRoles that are direct children of this role.
+ These roles' users are granted any privileges that this role has been granted
+ (e.g. read or write access through ACLs). You can add or remove child roles
+ from this role through this relation.
+ */
+@property (nonatomic, readonly, retain) PFRelation *roles;
+
+#pragma mark -
+#pragma mark Querying for Roles
+
+/** @name Querying for Roles */
++ (PFQuery *)query;
+
+@end