SFSDKSoslReturningBuilder Class Reference

Inherits from	NSObject
Declared in	SFSDKSoslReturningBuilder.h

Other Methods

`objectName`

Returns the object name for this builder

@property (nonatomic, strong, readonly) NSString *objectName

Declared In

SFSDKSoslReturningBuilder.h

`+ withObjectName:`

A builder to help create a returning statement.

+ (SFSDKSoslReturningBuilder *)withObjectName:(NSString *)name

Parameters

`name`	the object to return.

Return Value

the builder

Declared In

SFSDKSoslReturningBuilder.h

`– fields:`

A builder to help create a returning statement.

- (SFSDKSoslReturningBuilder *)fields:(NSString *)fields

Parameters

`fields`	a list of one or more fields to return for a given object, comma separated

Return Value

the builder

Declared In

SFSDKSoslReturningBuilder.h

`– whereClause:`

A builder to help create a returning statement.

- (SFSDKSoslReturningBuilder *)whereClause:(NSString *)whereClause

Parameters

`whereClause`	a description of how search results for the given object should be filtered, based on individual field values. If unspecified, the search retrieves all the rows in the object that are visible to the user

Return Value

the builder

Declared In

SFSDKSoslReturningBuilder.h

`– withNetwork:`

A builder to help create a returning statement.

- (SFSDKSoslReturningBuilder *)withNetwork:(NSString *)networkId

Parameters

`networkId`	The network id to scope this returning statement with, if necessary

Return Value

the builder

Declared In

SFSDKSoslReturningBuilder.h

`– orderBy:`

A builder to help create a returning statement.

- (SFSDKSoslReturningBuilder *)orderBy:(NSString *)orderBy

Parameters

`orderBy`	a description of how to order the returned result, including ascending and descending order, and how nulls are ordered

Return Value

the builder

Declared In

SFSDKSoslReturningBuilder.h

`– limit:`

A builder to help create a returning statement.

- (SFSDKSoslReturningBuilder *)limit:(NSInteger)limit

Parameters

`limit`	the maximum number of records returned for the given object. If unspecified, all matching records are returned, up to the limit set for the query as a whole

Return Value

the builder

Declared In

SFSDKSoslReturningBuilder.h

Query String Generation

`– build`

Builds a returning statement from the builder.

- (nullable NSString *)build

Return Value

the built returning statement

Declared In

SFSDKSoslReturningBuilder.h