akasha

Class CredentialsContainer

java.lang.Object

akasha.core.JsObject

akasha.CredentialsContainer

@Generated(value="org.realityforge.webtack")
 @JsType(isNative=true,
        namespace="<global>",
        name="CredentialsContainer")
public class CredentialsContainer
extends JsObject

The CredentialsContainer interface of the Credential Management API exposes methods to request credentials and notify the user agent when events such as successful sign in or sign out happen. This interface is accessible from Navigator.credentials.

See Also:

CredentialsContainer - MDN, # credentialscontainer

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CredentialsContainer()

Method Summary

Modifier and Type	Method and Description
@JsNonNull Promise<Credential>	create() The create() method of the CredentialsContainer interface returns a Promise that resolves with a new Credential instance based on the provided options, or null if no Credential object can be created.
@JsNonNull Promise<Credential>	create(CredentialCreationOptions options) The create() method of the CredentialsContainer interface returns a Promise that resolves with a new Credential instance based on the provided options, or null if no Credential object can be created.
@JsNonNull Promise<Credential>	get() The get() method of the CredentialsContainer interface returns a Promise to a single Credential instance that matches the provided parameters.
@JsNonNull Promise<Credential>	get(CredentialRequestOptions options) The get() method of the CredentialsContainer interface returns a Promise to a single Credential instance that matches the provided parameters.
@JsNonNull Promise<java.lang.Void>	preventSilentAccess() The preventSilentAccess() method of the CredentialsContainer interface sets a flag that specifies whether automatic log in is allowed for future visits to the current origin, then returns an empty Promise.
@JsNonNull Promise<Credential>	store(Credential credential) The store() method of the CredentialsContainer stores a set of credentials for the user inside a Credential instance, returning this in a Promise.

Methods inherited from class akasha.core.JsObject

assign, create, create, defineProperties, defineProperty, defineProperty, entries, freeze, fromEntries, getOwnPropertyDescriptor, getOwnPropertyDescriptor, getOwnPropertyDescriptors, getOwnPropertyNames, getOwnPropertySymbols, getPrototypeOf, hasOwnProperty, hasOwnProperty, is, isExtensible, isFrozen, isPrototypeOf, isSealed, keys, preventExtensions, propertyIsEnumerable, seal, setPrototypeOf, toString_, valueOf_, values

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CredentialsContainer

protected CredentialsContainer()

Method Detail

create

public @JsNonNull Promise<Credential> create(@Nonnull
                                             CredentialCreationOptions options)

The create() method of the CredentialsContainer interface returns a Promise that resolves with a new Credential instance based on the provided options, or null if no Credential object can be created.

See Also:

CredentialsContainer.create - MDN, get() - Credential Management Level 1, Web Authentication: An API for accessing Public Key Credentials Level 1

create

public @JsNonNull Promise<Credential> create()

The create() method of the CredentialsContainer interface returns a Promise that resolves with a new Credential instance based on the provided options, or null if no Credential object can be created.

See Also:

CredentialsContainer.create - MDN, get() - Credential Management Level 1, Web Authentication: An API for accessing Public Key Credentials Level 1

get

public @JsNonNull Promise<Credential> get(@Nonnull
                                          CredentialRequestOptions options)

The get() method of the CredentialsContainer interface returns a Promise to a single Credential instance that matches the provided parameters. If no match is found the Promise will resolve to null.

See Also:

CredentialsContainer.get - MDN, get() - Credential Management Level 1, Web Authentication: An API for accessing Public Key Credentials Level 1

get

public @JsNonNull Promise<Credential> get()

The get() method of the CredentialsContainer interface returns a Promise to a single Credential instance that matches the provided parameters. If no match is found the Promise will resolve to null.

See Also:

CredentialsContainer.get - MDN, get() - Credential Management Level 1, Web Authentication: An API for accessing Public Key Credentials Level 1

preventSilentAccess

public @JsNonNull Promise<java.lang.Void> preventSilentAccess()

The preventSilentAccess() method of the CredentialsContainer interface sets a flag that specifies whether automatic log in is allowed for future visits to the current origin, then returns an empty Promise.

See Also:

CredentialsContainer.preventSilentAccess - MDN, preventSilentAccess() - Credential Management Level 1

store

public @JsNonNull Promise<Credential> store(@Nonnull
                                            Credential credential)

The store() method of the CredentialsContainer stores a set of credentials for the user inside a Credential instance, returning this in a Promise.

See Also:

CredentialsContainer.store - MDN, Credential Management Level 1