quick-reference.md

sidebar_position: 3
// cd into the `client` directory
go doc -all ./api
go doc -all ./interfaces
func (c *Client) GetRoundEvents() interfaces.RoundEvents
type RoundEvents interface {
        // designates a callback to call on the specified event
        // rid is the id of the round the event occurs on
        // callback is the callback the event is triggered on
        // timeout is the amount of time before an error event is returned
        // valid states are the states which the event should trigger on
        AddRoundEvent(rid id.Round, callback ds.RoundEventCallback,
                timeout time.Duration, validStates ...states.Round) *ds.EventCallback

        // designates a go channel to signal the specified event
        // rid is the id of the round the event occurs on
        // eventChan is the channel the event is triggered on
        // timeout is the amount of time before an error event is returned
        // valid states are the states which the event should trigger on
        AddRoundEventChan(rid id.Round, eventChan chan ds.EventReturn,
                timeout time.Duration, validStates ...states.Round) *ds.EventCallback

        //Allows the un-registration of a round event before it triggers
        Remove(rid id.Round, e *ds.EventCallback)
}
// Callbacks must use this function signature
type RoundEventCallback func(ri *pb.RoundInfo, timedOut bool)
const (
        // SaltSize size of user salts
        SaltSize = 32
)
func CompressJpeg(imgBytes []byte) ([]byte, error)
func CompressJpegForPreview(imgBytes []byte) ([]byte, error)
func DownloadAndVerifySignedNdfWithUrl(url, cert string) ([]byte, error)
func LoadSecretWithMnemonic(mnemonic, path string) (secret []byte, err error)
func NewClient(ndfJSON, storageDir string, password []byte,
        registrationCode string) error
func NewPrecannedClient(precannedID uint, defJSON, storageDir string,
        password []byte) error
func NewProtoClient_Unsafe(ndfJSON, storageDir string, password,
        protoClientJSON []byte) error
func NewVanityClient(ndfJSON, storageDir string, password []byte,
        registrationCode string, userIdPrefix string) error
func StoreSecretWithMnemonic(secret []byte, path string) (string, error)
type Client struct {
        // Has unexported fields.
}
func Login(storageDir string, password []byte, parameters params.Network) (*Client, error)
func LoginWithNewBaseNDF_UNSAFE(storageDir string, password []byte,
        newBaseNdf string, parameters params.Network) (*Client, error)
func LoginWithProtoClient(storageDir string, password []byte, protoClientJSON []byte,
        newBaseNdf string, parameters params.Network) (*Client, error)
func OpenClient(storageDir string, password []byte, parameters params.Network) (*Client, error)
func (c *Client) AddService(sp Service) error
func (c *Client) ConfirmAuthenticatedChannel(recipient contact.Contact) (id.Round, error)
func (c *Client) ConstructProtoUerFile() ([]byte, error)
func (c *Client) DeleteAllRequests() error
func (c *Client) DeleteContact(partnerId *id.ID) error
func (c *Client) DeleteReceiveRequests() error
func (c *Client) DeleteSentRequests() error
func (c *Client) GetAuthRegistrar() interfaces.Auth
func (c *Client) GetAuthenticatedChannelRequest(partner *id.ID) (contact.Contact, error)
func (c *Client) GetComms() *client.Comms
func (c *Client) GetErrorsChannel() <-chan interfaces.ClientError
func (c *Client) GetHealth() interfaces.HealthTracker
func (c *Client) GetNetworkInterface() interfaces.NetworkManager
func (c *Client) GetNodeRegistrationStatus() (int, int, error)
func (c *Client) GetPreferredBins(countryCode string) ([]string, error)
func (c *Client) GetRateLimitParams() (uint32, uint32, int64)
func (c *Client) GetRelationshipFingerprint(partner *id.ID) (string, error)
func (c *Client) GetRng() *fastRNG.StreamGenerator
func (c *Client) GetRoundEvents() interfaces.RoundEvents
func (c *Client) GetRoundResults(roundList []id.Round, timeout time.Duration,
        roundCallback RoundEventCallback) error
func (c *Client) GetStorage() *storage.Session
func (c *Client) GetSwitchboard() interfaces.Switchboard
func (c *Client) GetUser() user.User
func (c *Client) HasAuthenticatedChannel(partner *id.ID) bool
func (c *Client) HasRunningProcessies() bool
func (c *Client) MakePrecannedAuthenticatedChannel(precannedID uint) (contact.Contact, error)
func (c *Client) MakePrecannedContact(precannedID uint) contact.Contact
func (c *Client) NetworkFollowerStatus() Status
func (c *Client) NewCMIXMessage(contents []byte) (format.Message, error)
func (c *Client) RegisterEventCallback(name string,
        myFunc interfaces.EventCallbackFunction) error
func (c *Client) RegisterForNotifications(token string) error
func (c *Client) ReportEvent(priority int, category, evtType, details string)
func (c *Client) RequestAuthenticatedChannel(recipient, me contact.Contact,
        message string) (id.Round, error)
func (c *Client) SendCMIX(msg format.Message, recipientID *id.ID,
        param params.CMIX) (id.Round, ephemeral.Id, error)
func (c *Client) SendE2E(m message.Send, param params.E2E) ([]id.Round,
        e2e.MessageID, time.Time, error)
func (c *Client) SendManyCMIX(messages []message.TargetedCmixMessage,
        params params.CMIX) (id.Round, []ephemeral.Id, error)
func (c *Client) SendUnsafe(m message.Send, param params.Unsafe) ([]id.Round,
        error)
func (c *Client) SetProxiedBins(binStrings []string) error
func (c *Client) StartNetworkFollower(timeout time.Duration) error
func (c *Client) StopNetworkFollower() error
func (c *Client) UnregisterEventCallback(name string)
func (c *Client) UnregisterForNotifications() error
func (c *Client) VerifyOwnership(received, verified contact.Contact) bool
type RoundEventCallback func(allRoundsSucceeded, timedOut bool, rounds map[id.Round]RoundResult)
type RoundResult uint
const (
        TimeOut RoundResult = iota
        Failed
        Succeeded
)
func (rr RoundResult) String() string
type Service func() (stoppable.Stoppable, error)
type Status int
const (
        Stopped  Status = 0
        Running  Status = 2000
        Stopping Status = 3000
)
func (s Status) String() string