ZDCSearchResult

@interface ZDCSearchResult : NSObject <NSCopying>

A search result represents a particular user, along with their basic cloud information & linked identities.

  • The user’s ID (a 32 character string)

    Declaration

    Objective-C

    @property (readonly, nonatomic) NSString *_Nonnull userID;

    Swift

    var userID: String { get }
  • The AWS region where the user’s bucket resides.

    Declaration

    Objective-C

    @property (readonly, nonatomic) AWSRegion aws_region;

    Swift

    var aws_region: AWSRegion { get }
  • The name of the user’s S3 bucket.

    Declaration

    Objective-C

    @property (readonly, nonatomic) NSString *_Nonnull aws_bucket;

    Swift

    var aws_bucket: String { get }
  • The list of linked social identities for the user’s account.

    Declaration

    Objective-C

    @property (readonly, nonatomic) NSArray<ZDCUserIdentity *> *_Nonnull identities;

    Swift

    var identities: [ZDCUserIdentity] { get }
  • Detailed information concerning how this user matched the query.

    Declaration

    Objective-C

    @property (readonly, nonatomic) NSArray<ZDCSearchMatch *> *_Nonnull matches;

    Swift

    var matches: [ZDCSearchMatch] { get }
  • The preferredIdentityID controls how the system prefers to display the user within the UI.

    Declaration

    Objective-C

    @property (readwrite, copy, nonatomic) NSString *_Nonnull preferredIdentityID;

    Swift

    var preferredIdentityID: String { get set }
  • Extracts an identity for the user from their list of linked identities. The preferredIdentity is used, if configured. Otherwise, an identity is selected from the list of identities.

    Declaration

    Objective-C

    @property (readonly, nonatomic) ZDCUserIdentity *_Nonnull displayIdentity;

    Swift

    var displayIdentity: ZDCUserIdentity { get }
  • Returns the identity with the given ID, if it exists.

    Declaration

    Objective-C

    - (nullable ZDCUserIdentity *)identityWithID:(nonnull NSString *)identityID;

    Swift

    func identity(withID identityID: String) -> ZDCUserIdentity?
  • create a ZDCSearchResult from an existing ZDCUser

    Declaration

    Objective-C

    - (nonnull instancetype)initWithUser:(nonnull ZDCUser *)user;

    Swift

    init(user: ZDCUser)