A class, representing the credentials used for authenticating a User.
Namespace: Realms.Sync Assembly: Realm.dll Syntax Properties | Edit this page View Source ProviderGets a value indicating which Credentials.AuthProvider these Credentials are using.
Declaration[Preserve]
public Credentials.AuthProvider Provider { get; }
Property Value Methods | Edit this page View Source Anonymous(bool)
Creates credentials representing an anonymous user.
Declarationpublic static Credentials Anonymous(bool reuseExisting = true)
Parameters Type Name Description bool reuseExisting
A value indicating whether anonymous users should be reused. Passing true
means that multiple calls to app.LoginAsync(Credentials.Anonymous())
will return the same anonymous user as long as that user hasn't logged out. If reuseExisting
is false
, every time you call LogInAsync(Credentials), a new user will be created on the server.
A Credentials that can be used to authenticate an anonymous user.
See Also | Edit this page View Source ApiKey(string)Creates credentials representing a login using an API key generated by a client SDK.
Declarationpublic static Credentials ApiKey(string key)
Parameters Type Name Description string key
The API key to use for login.
Returns Type Description CredentialsA Credentials that can be used to authenticate user with an API key.
See Also | Edit this page View Source Apple(string)Creates credentials representing a login using an Apple ID access token.
Declarationpublic static Credentials Apple(string accessToken)
Parameters Type Name Description string accessToken
The OAuth 2.0 access token representing the user's Apple ID.
Returns Type Description CredentialsA Credentials that can be used to authenticate a user via an Apple ID.
See Also | Edit this page View Source EmailPassword(string, string)Creates credentials representing a login using an email and password.
Declarationpublic static Credentials EmailPassword(string email, string password)
Parameters Type Name Description string email
The user's email.
string passwordThe user's password.
Returns Type Description CredentialsA Credentials that can be used to authenticate a user with their email and password.
See Also | Edit this page View Source Facebook(string)Creates credentials representing a login using a Facebook access token.
Declarationpublic static Credentials Facebook(string accessToken)
Parameters Type Name Description string accessToken
The OAuth 2.0 access token representing the Facebook user.
Returns Type Description CredentialsA Credentials that can be used to authenticate a user with Facebook.
See Also | Edit this page View Source Function(object)Creates credentials representing a login with Realm function.
Declarationpublic static Credentials Function(object payload)
Parameters Type Name Description object payload
The payload that will be passed as an argument to the server function.
Returns Type Description CredentialsA Credentials that can be used to authenticate a user by invoking a server function.
See Also | Edit this page View Source Google(string, GoogleCredentialType)Creates credentials representing a login using a Google account.
Declarationpublic static Credentials Google(string credential, GoogleCredentialType type)
Parameters Type Name Description string credential
The credential representing the Google user.
GoogleCredentialType typeThe type of the credential.
Returns Type Description CredentialsA Credentials that can be used to authenticate a user with Google.
See Also | Edit this page View Source JWT(string)Creates credentials representing a login using a JWT Token.
Declarationpublic static Credentials JWT(string customToken)
Parameters Type Name Description string customToken
The custom JWT token representing the user.
Returns Type Description CredentialsA Credentials that can be used to authenticate a user with a custom JWT Token.
See Also | Edit this page View Source ServerApiKey(string)Creates credentials representing a login using an API key generated in the server UI.
Declaration[Obsolete("Use Credentials.ApiKey instead.")]
public static Credentials ServerApiKey(string serverApiKey)
Parameters Type Name Description string serverApiKey
The server API key to use for login.
Returns Type Description CredentialsA Credentials that can be used to authenticate user with an API key.
See AlsoRetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4