client

Documentation

Index

• func GetStrongDocGrpcClient() (proto.StrongDocServiceClient, error)
• type ServiceLocation
• type StrongDocClient
  • func CreateStrongDocClient(location ServiceLocation) (StrongDocClient, error)
  • func GetStrongDocClient() (StrongDocClient, error)
  • func InitStrongDocClient(location ServiceLocation, reset bool) (StrongDocClient, error)

Functions

func GetStrongDocGrpcClient

func GetStrongDocGrpcClient() (proto.StrongDocServiceClient, error)

GetStrongDocGrpcClient gets a singleton gRPC StrongDocServiceClient

Types

type ServiceLocation

type ServiceLocation string

ServiceLocation specifies the location of the StrongDoc service

const (
	// DEFAULT is the default production service location
	DEFAULT ServiceLocation = "DEFAULT"
	// SANDBOX is the sandbox testing location
	SANDBOX ServiceLocation = "SANDBOX"
	// QA is the QA service used only for testing
	QA ServiceLocation = "QA"
	// LOCAL is the local service location used only for testing
	LOCAL ServiceLocation = "LOCAL"
)

type StrongDocClient

type StrongDocClient interface {
	Login(userID, password, orgID string) (token string, err error)
	GetNoAuthConn() *grpc.ClientConn
	GetAuthConn() *grpc.ClientConn
	GetGrpcClient() proto.StrongDocServiceClient
	Close()
}

StrongDocClient encapsulates the client object that allows connection to the remote service

func CreateStrongDocClient

func CreateStrongDocClient(location ServiceLocation) (StrongDocClient, error)

CreateStrongDocClient creates an instance of StrongDocClient

func GetStrongDocClient

func GetStrongDocClient() (StrongDocClient, error)

GetStrongDocClient gets a singleton StrongDocClient

func InitStrongDocClient

func InitStrongDocClient(location ServiceLocation, reset bool) (StrongDocClient, error)

InitStrongDocClient initializes a singleton StrongDocClient