keybase

README

Bind

Go bindable package that includes both Keybase client and KBFS for gomobile builds.

Documentation

Index

• func AppDidEnterBackground() bool
• func AppWillExit()
• func BackgroundSync()
• func ForceGC()
• func HandleBackgroundNotification(strConvID string, intMembersType int, intMessageID int, pushID string, ...) (err error)
• func Init(homeDir string, logFile string, runModeStr string, accessGroupOverride bool, ...) error
• func InitOnce(homeDir string, logFile string, runModeStr string, accessGroupOverride bool, ...)
• func LogSend(status string, feedback string, sendLogs bool, uiLogPath, traceDir string) (string, error)
• func ReadB64() (string, error)
• func Reset() error
• func SetAppStateBackground()
• func SetAppStateBackgroundActive()
• func SetAppStateForeground()
• func SetAppStateInactive()
• func Version() string
• func WriteB64(str string) error
• type ExternalDNSNSFetcher
• type PushNotifier

Functions

func AppDidEnterBackground

func AppDidEnterBackground() bool

AppDidEnterBackground notifies the service that the app is in the background [iOS] returning true will request about ~3mins from iOS to continue execution

func AppWillExit

func AppWillExit()

AppWillExit is called reliably on iOS when the app is about to terminate not as reliably on android

func BackgroundSync

func BackgroundSync()

func ForceGC

func ForceGC()

ForceGC Forces a gc

func HandleBackgroundNotification

func HandleBackgroundNotification(strConvID string, intMembersType int, intMessageID int,
	pushID string, badgeCount int, unixTime int, body string, pusher PushNotifier) (err error)

func Init

func Init(homeDir string, logFile string, runModeStr string, accessGroupOverride bool,
	externalDNSNSFetcher ExternalDNSNSFetcher) error

Init runs the Keybase services

func InitOnce

func InitOnce(homeDir string, logFile string, runModeStr string, accessGroupOverride bool,
	dnsNSFetcher ExternalDNSNSFetcher)

InitOnce runs the Keybase services (only runs one time)

func LogSend

func LogSend(status string, feedback string, sendLogs bool, uiLogPath, traceDir string) (string, error)

LogSend sends a log to Keybase

func ReadB64

func ReadB64() (string, error)

ReadB64 is a blocking read for base64 encoded msgpack rpc data. It is called serially by the mobile run loops.

func Reset

func Reset() error

Reset resets the socket connection

func SetAppStateBackground

func SetAppStateBackground()

func SetAppStateBackgroundActive

func SetAppStateBackgroundActive()

func SetAppStateForeground

func SetAppStateForeground()

func SetAppStateInactive

func SetAppStateInactive()

func Version

func Version() string

Version returns semantic version string

func WriteB64

func WriteB64(str string) error

WriteB64 sends a base64 encoded msgpack rpc payload

Types

type ExternalDNSNSFetcher

type ExternalDNSNSFetcher interface {
	GetServers() []byte
}

type PushNotifier

type PushNotifier interface {
	LocalNotification(ident string, msg string, badgeCount int, soundName string, convID string, typ string)
}