options

Documentation

Overview

Package options contains shared properties/helpers to be consumed by other packages.

Index

• type ClientOptions
  • func (c *ClientOptions) Validate() error
• type Credential

Types

type ClientOptions

type ClientOptions struct {
	AppID         *string     `yaml:"appid" json:"app_id,omitempty"`
	AuthMechanism *string     `yaml:"provider" json:"provider,omitempty"`
	Credential    *Credential `yaml:"credential,omitempty" json:"credential,omitempty"`
}

ClientOptions to connect to Realm

func (*ClientOptions) Validate

func (c *ClientOptions) Validate() error

Validate validates the client options. This method will return the first error found.

type Credential

type Credential struct {
	Username *string `json:"username,omitempty" yaml:"username,omitempty"`
	Password *string `json:"password,omitempty" yaml:"password,omitempty"`
	Key      *string `json:"key,omitempty" yaml:"key,omitempty"`
	Token    *string `json:"token,omitempty" yaml:"token,omitempty"`
}

Credential are provider-agnostic, fill only needed or omit if using anonymous authentication