Public Member Functions | Static Public Member Functions | Properties

S3Grantee Class Reference

Represents an Owner/User/Group that can be given permissions on a bucket or object. More...

#import <S3Grantee.h>

Inherits S3Owner.

List of all members.

Public Member Functions

(NSString *) - toXml
 Returns the XML representation of the grantee.

Static Public Member Functions

(id) + granteeWithID:withDisplayName:
 Returns an initialized S3Grantee object representing a CanonicalUser with the specified ID and displayName.
(id) + granteeWithURI:
 Returns an initialized S3Grantee representing a group with the specified URI.
(id) + granteeWithEmailAddress:
 Returns an initialized S3Grantee representing a user with the specified email address.
(id) + allUsers
 Represents the group of all users.
(id) + authenticatedUsers
 Represents the group of authenticated users.

Properties

NSString * URI
 Gets and sets the URI property for group grantees.
NSString * emailAddress
 Gets and sets the emailAddress property for user grantees.

Detailed Description

Represents an Owner/User/Group that can be given permissions on a bucket or object.

Use Either ID and displayName (for CanonicalUsers), URI (for Groups), or emailAddress (for Amazon customer email addresses).

See also:
http://docs.amazonwebservices.com/AmazonS3/latest/index.html?RESTAuthentication.html

Member Function Documentation

+ (id S3Grantee.)granteeWithEmailAddress: (NSString *)  theEmailAddress  

Returns an initialized S3Grantee representing a user with the specified email address.

Parameters:
theEmailAddress The email address of the user.
Returns:
An initialized S3Grantee representing a user with the specified email address.
+ (id S3Grantee.)granteeWithID: (NSString *)  theID
withDisplayName: (NSString *)  theDisplayName 

Returns an initialized S3Grantee object representing a CanonicalUser with the specified ID and displayName.

Parameters:
theID The ID of the user.
theDisplayName The display name of the user.
Returns:
An initialized S3Grantee object representing a CanonicalUser with the specified ID and displayName.
+ (id S3Grantee.)granteeWithURI: (NSString *)  theURI  

Returns an initialized S3Grantee representing a group with the specified URI.

Parameters:
theURI The URI for the group.
Returns:
An initialized S3Grantee representing a group with the specified URI.

The documentation for this class was generated from the following file: