APICredentials class OmniIndex Methods OmniIndex Authorization Getting Started

APICredentials class object that represents a set of credentials for accessing a v1 API. Example Usage:

// Create an instance of APICredentials
APICredentials credentials = APICredentials
                              .withDomainKey(APICredentials(aPIServer: 'test-api-server',
                                seedNode: 'test-seed-node',
                                localDomain: 'com.omniindex.test',
                                nodeServer: 'test-node-server.io',
                                domainKey: 'test-domain-key');
print(credentials.nodeServer);
Inheritance

Constructors

APICredentials({String? aPIServer, String? seedNode, String? nodeServer, String? localDomain, String username = '', String password = '', OmniIndexAuthenticationType type = OmniIndexAuthenticationType.api})
Constructs an APICredentials object with the required properties.
APICredentials.withDomainKey({String? aPIServer, String? seedNode, String? localDomain, String? nodeServer, String? domainKey, String username = '', String password = '', OmniIndexAuthenticationType type = OmniIndexAuthenticationType.api})
Constructs an APICredentials object with the domain key.

Properties

aPIServer ↔ String?
The API server to communicate with.
getter/setter pair
domainKey ↔ String?
The domain key.
getter/setter pair
hashCode → int
The hash code for this object.
no setterinherited
localDomain ↔ String?
The local domain.
getter/setter pair
nodeServer ↔ String?
The node server.
getter/setter pair
password ↔ String
The user password
getter/setter pairinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
seedNode ↔ String?
The seed node.
getter/setter pair
type ↔ OmniIndexAuthenticationType
The type of authentication
getter/setter pairinherited
username ↔ String
The user name.
getter/setter pairinherited

Methods

areValid() → bool
Checks if all the properties are not null and not empty.
override
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited