RLMCredentials

Objective-C


@interface RLMCredentials : NSObject

Swift

@_nonSendable(_assumed) class RLMCredentials : NSObject, @unchecked Sendable

Opaque credentials representing a specific Realm App user.

Show on GitHub

  • The name of the identity provider which generated the credentials token.

    Declaration

    Objective-C

    @property (nonatomic, readonly) RLMIdentityProvider _Nonnull provider;

    Swift

    var provider: RLMIdentityProvider { get }
    Show on GitHub

  • Construct and return credentials from a Facebook account token.

    Declaration

    Objective-C

    + (nonnull instancetype)credentialsWithFacebookToken:
    (nonnull RLMCredentialsToken)token;

    Swift

    convenience init(facebookToken token: String)
    Show on GitHub

  • Construct and return credentials from a Google account token.

    Declaration

    Objective-C

    + (nonnull instancetype)credentialsWithGoogleAuthCode:
    (nonnull RLMCredentialsToken)token;

    Swift

    convenience init(googleAuthCode token: String)
    Show on GitHub

  • Construct and return credentials from a Google id token.

    Declaration

    Objective-C

    + (nonnull instancetype)credentialsWithGoogleIdToken:
    (nonnull RLMCredentialsToken)token;

    Swift

    convenience init(googleIdToken token: String)
    Show on GitHub

  • Construct and return credentials from an Apple account token.

    Declaration

    Objective-C

    + (nonnull instancetype)credentialsWithAppleToken:
    (nonnull RLMCredentialsToken)token;

    Swift

    convenience init(appleToken token: String)
    Show on GitHub

  • Construct and return credentials for an Atlas App Services function using a mongodb document as a json payload.

    Declaration

    Objective-C

    + (nonnull instancetype)credentialsWithFunctionPayload:
    (nonnull NSDictionary<NSString *, id<RLMBSON>> *)payload;

    Swift

    convenience init(functionPayload payload: [String : any RLMBSON])
    Show on GitHub

  • Construct and return credentials from a user api key.

    Declaration

    Objective-C

    + (nonnull instancetype)credentialsWithUserAPIKey:(nonnull NSString *)apiKey;

    Swift

    convenience init(userAPIKey apiKey: String)
    Show on GitHub

  • Construct and return credentials from a server api key.

    Declaration

    Objective-C

    + (nonnull instancetype)credentialsWithServerAPIKey:(nonnull NSString *)apiKey;

    Swift

    convenience init(serverAPIKey apiKey: String)
    Show on GitHub

  • Construct and return Atlas App Services credentials from an email and password.

    Declaration

    Objective-C

    + (nonnull instancetype)credentialsWithEmail:(nonnull NSString *)email
                                    password:(nonnull NSString *)password;

    Swift

    convenience init(email: String, password: String)
    Show on GitHub

  • Construct and return credentials from a JSON Web Token.

    Declaration

    Objective-C

    + (nonnull instancetype)credentialsWithJWT:(nonnull NSString *)token;

    Swift

    convenience init(jwt token: String)
    Show on GitHub

  • Construct and return anonymous credentials

    Declaration

    Objective-C

    + (nonnull instancetype)anonymousCredentials;

    Swift

    class func anonymous() -> Self
    Show on GitHub