SFIdentityData Class Reference

Inherits from	NSObject
Conforms to	NSSecureCoding
Declared in	SFIdentityData.h

Overview

The data structure for the identity data that’s retrieved from the Salesforce service.

Other Methods

`dictRepresentation`

The NSDictionary representation of this identity data.

@property (nonnull, strong, nonatomic, readonly) NSDictionary *dictRepresentation

Declared In

SFIdentityData.h

`idUrl`

The ID URL.

@property (nonnull, strong, nonatomic, readonly) NSURL *idUrl

Declared In

SFIdentityData.h

`assertedUser`

Whether or not this is the asserted user for this session.

@property (readonly) BOOL assertedUser

Declared In

SFIdentityData.h

`userId`

The User ID of the associated user.

@property (nonnull, strong, nonatomic, readonly) NSString *userId

Declared In

SFIdentityData.h

`orgId`

The Organization ID of the associated user.

@property (nonnull, strong, nonatomic, readonly) NSString *orgId

Declared In

SFIdentityData.h

`username`

The username of the associated user.

@property (nonnull, strong, nonatomic, readonly) NSString *username

Declared In

SFIdentityData.h

`nickname`

The nickname of the associated user.

@property (nullable, strong, nonatomic, readonly) NSString *nickname

Declared In

SFIdentityData.h

`displayName`

The display name of the associated user.

@property (nullable, strong, nonatomic, readonly) NSString *displayName

Declared In

SFIdentityData.h

`email`

The email address of the associated user.

@property (nonnull, strong, nonatomic, readonly) NSString *email

Declared In

SFIdentityData.h

`firstName`

The first name of the user.

@property (nullable, strong, nonatomic, readonly) NSString *firstName

Declared In

SFIdentityData.h

`lastName`

The last name of the user.

@property (nonnull, strong, nonatomic, readonly) NSString *lastName

Declared In

SFIdentityData.h

`pictureUrl`

The URL to retrieve the user’s picture.

@property (nullable, strong, nonatomic, readonly) NSURL *pictureUrl

Declared In

SFIdentityData.h

`thumbnailUrl`

The URL to retrieve a thumbnail picture for the user.

@property (nullable, strong, nonatomic, readonly) NSURL *thumbnailUrl

Declared In

SFIdentityData.h

`enterpriseSoapUrl`

The enterprise SOAP API URL string for this user. Note: API URLs require replacement of the version token with a valid API version string.

@property (nullable, strong, nonatomic, readonly) NSString *enterpriseSoapUrl

Declared In

SFIdentityData.h

`metadataSoapUrl`

The metadata SOAP API URL string for this user. Note: API URLs require replacement of the version token with a valid API version string.

@property (nullable, strong, nonatomic, readonly) NSString *metadataSoapUrl

Declared In

SFIdentityData.h

`partnerSoapUrl`

The partner SOAP API URL string for this user. Note: API URLs require replacement of the version token with a valid API version string.

@property (nullable, strong, nonatomic, readonly) NSString *partnerSoapUrl

Declared In

SFIdentityData.h

`restUrl`

The REST API URL string entry point for this user. Note: API URLs require replacement of the version token with a valid API version string.

@property (nullable, strong, nonatomic, readonly) NSString *restUrl

Declared In

SFIdentityData.h

`restSObjectsUrl`

The REST endpoint string for SObjects. Note: API URLs require replacement of the version token with a valid API version string.

@property (nullable, strong, nonatomic, readonly) NSString *restSObjectsUrl

Declared In

SFIdentityData.h

`restSearchUrl`

The REST endpoint string for search. Note: API URLs require replacement of the version token with a valid API version string.

@property (nullable, strong, nonatomic, readonly) NSString *restSearchUrl

Declared In

SFIdentityData.h

`restQueryUrl`

The REST endpoint string for queries. Note: API URLs require replacement of the version token with a valid API version string.

@property (nullable, strong, nonatomic, readonly) NSString *restQueryUrl

Declared In

SFIdentityData.h

`restRecentUrl`

The REST endpoint string for recent activity. Note: API URLs require replacement of the version token with a valid API version string.

@property (nullable, strong, nonatomic, readonly) NSString *restRecentUrl

Declared In

SFIdentityData.h

`profileUrl`

The user profile URL.

@property (nullable, strong, nonatomic, readonly) NSURL *profileUrl

Declared In

SFIdentityData.h

`chatterFeedsUrl`

The URL string for Chatter feeds. Note: API URLs require replacement of the version token with a valid API version string.

@property (nullable, strong, nonatomic, readonly) NSString *chatterFeedsUrl

Declared In

SFIdentityData.h

`chatterGroupsUrl`

The URL string for Chatter groups. Note: API URLs require replacement of the version token with a valid API version string.

@property (nullable, strong, nonatomic, readonly) NSString *chatterGroupsUrl

Declared In

SFIdentityData.h

`chatterUsersUrl`

The URL string for Chatter users. Note: API URLs require replacement of the version token with a valid API version string.

@property (nullable, strong, nonatomic, readonly) NSString *chatterUsersUrl

Declared In

SFIdentityData.h

`chatterFeedItemsUrl`

The URL string for Chatter feed items. Note: API URLs require replacement of the version token with a valid API version string.

@property (nullable, strong, nonatomic, readonly) NSString *chatterFeedItemsUrl

Declared In

SFIdentityData.h

`isActive`

Whether or not this user is active.

@property (readonly) BOOL isActive

Declared In

SFIdentityData.h

`userType`

The user type.

@property (nonnull, strong, nonatomic, readonly) NSString *userType

Declared In

SFIdentityData.h

`language`

The user’s configured language.

@property (nonnull, strong, nonatomic, readonly) NSString *language

Declared In

SFIdentityData.h

`locale`

The user’s configured locale.

@property (nonnull, strong, nonatomic, readonly) NSString *locale

Declared In

SFIdentityData.h

`utcOffset`

The UTC offset for this user.

@property (readonly) int utcOffset

Declared In

SFIdentityData.h

`mobilePoliciesConfigured`

Whether or not any additional mobile security policies have been configured for this application.

@property (readonly) BOOL mobilePoliciesConfigured

Declared In

SFIdentityData.h

`mobileAppPinLength`

The length of the PIN code, if it’s required. Defaults to 0 if not set, but querying mobilePoliciesConfigured is recommended to validate that policies are set.

@property (readonly) int mobileAppPinLength

Declared In

SFIdentityData.h

`mobileAppScreenLockTimeout`

The length of time in minutes before the app will be locked, if it’s required. Defaults to -1 if not set, but querying mobilePoliciesConfigured is recommended to validate that policies are set.

@property (readonly) int mobileAppScreenLockTimeout

Declared In

SFIdentityData.h

`customAttributes`

An optional dictionary of custom attributes defined on the Connected App.

@property (nullable, strong, nonatomic, readonly) NSDictionary *customAttributes

Declared In

SFIdentityData.h

`customPermissions`

An optional dictionary of custom permissions defined on the Connected App.

@property (nullable, strong, nonatomic, readonly) NSDictionary *customPermissions

Declared In

SFIdentityData.h

`lastModifiedDate`

The date this record was last modified.

@property (nullable, strong, nonatomic, readonly) NSDate *lastModifiedDate

Declared In

SFIdentityData.h

`nativeLogin`

Wheher or not the user was added via Native Login. The profile of this user restricts them from certain flows, such as IDP.

@property (readonly) BOOL nativeLogin

Declared In

SFIdentityData.h

`– initWithJsonDict:`

Designated initializer for creating an instance of the SFIdentityData object.

- (nonnull instancetype)initWithJsonDict:(nonnull NSDictionary *)jsonDict

Parameters

`jsonDict`	The JSON dictionary containing the user data.

Declared In

SFIdentityData.h

Extension Methods

`+ dateFromRfc822String:`

Creates an NSDate object from an RFC 822-formatted date string.

+ (NSDate *)dateFromRfc822String:(NSString *)dateString

Parameters

`dateString`	The date string to parse into an NSDate.

Return Value

The NSDate representation of the date string.

Declared In

SFIdentityData+Internal.h

`– parentExistsOrNilForUrl:childKey:`

Returns the URL configured in the sub-object of the parent, or nil if the parent object does not exist.

- (NSURL *)parentExistsOrNilForUrl:(NSString *)parentKey childKey:(NSString *)childKey

Parameters

`parentKey`	The data key associated with the parent object.
`childKey`	The data key associated with the child object where the URL is configured.

Return Value

The NSURL representation configured in the child object, or nil if the parent does not exist.

Declared In

SFIdentityData+Internal.h

`– parentExistsOrNilForString:childKey:`

Returns the NSString configured in the sub-object of the parent, or nil if the parent object does not exist.

- (NSString *)parentExistsOrNilForString:(NSString *)parentKey childKey:(NSString *)childKey

Parameters

`parentKey`	The data key associated with the parent object.
`childKey`	The data key associated with the child object where the string is configured.

Return Value

The NSString representation configured in the child object, or nil if the parent does not exist.

Declared In

SFIdentityData+Internal.h