domain

Documentation

Index

• type APIError
• type APISessionTokens
• type AddItemResult
• type AddItemsResponse
• type AddWatchFile
• type AppConfig
• type DirEntry
• type FileInfo
• type FileSharingInfo
• type FullPath
• type Identity
• type Invitation
• type InvitationReply
• type InvitationStatus
• type KeyBackupType
  • func (b KeyBackupType) String() string
• type KeyPair
• type Member
• type MessageBody
• type MirrorFile
• type Notification
• type NotificationTypes
• type OpenFileInfo
• type RevokedInvitation
• type SearchFileEntry
• type SharedDirEntry
• type SharedFilesRoleAction
• type ThreadInfo
• type UsageAlert

Types

type APIError

type APIError struct {
	Message string `json:"message"`
}

type APISessionTokens

type APISessionTokens struct {
	HubToken      string
	ServicesToken string
}

type AddItemResult

type AddItemResult struct {
	SourcePath string
	BucketPath string
	Bytes      int64
	Error      error
}

type AddItemsResponse

type AddItemsResponse struct {
	TotalFiles int64
	TotalBytes int64
	Error      error
}

type AddWatchFile

type AddWatchFile struct {
	DbId       string `json:"dbId"`
	LocalPath  string `json:"local_path"`
	BucketPath string `json:"bucket_path"`
	BucketKey  string `json:"bucket_key"`
	BucketSlug string `json:"bucket_slug"`
	IsRemote   bool   `json:"isRemote"`
	Cid        string `json:"cid"`
}

type AppConfig

type AppConfig struct {
	Port                 int
	AppPath              string
	TextileHubTarget     string
	TextileThreadsTarget string
}

type DirEntry

type DirEntry struct {
	Path          string
	IsDir         bool
	Name          string
	SizeInBytes   string
	Created       string
	Updated       string
	FileExtension string
	Members       []Member
}

type FileInfo

type FileInfo struct {
	DirEntry
	IpfsHash          string
	BackedUp          bool
	LocallyAvailable  bool
	BackupInProgress  bool
	RestoreInProgress bool
}

type FileSharingInfo

type FileSharingInfo struct {
	Bucket            string
	SharedFileCid     string
	SharedFileKey     string
	SpaceDownloadLink string
}

type FullPath

type FullPath struct {
	DbId      string `json:"dbId"`
	BucketKey string `json:"bucketKey"`
	Bucket    string `json:"bucket"`
	Path      string `json:"path"`
}

type Identity

type Identity struct {
	Address   string `json:"address"`
	PublicKey string `json:"publicKey"`
	Username  string `json:"username"`
}

type Invitation

type Invitation struct {
	InviterPublicKey string           `json:"inviterPublicKey"`
	InviteePublicKey string           `json:"inviteePublicKey"`
	InvitationID     string           `json:"invitationID"`
	Status           InvitationStatus `json:"status"`
	ItemPaths        []FullPath       `json:"itemPaths"`
	Keys             [][]byte         `json:"keys"`
}

type InvitationReply

type InvitationReply struct {
	InvitationID string `json:"invitationID"`
}

type InvitationStatus

type InvitationStatus int

const (
	PENDING  InvitationStatus = 0
	ACCEPTED InvitationStatus = 1
	REJECTED InvitationStatus = 2
)

type KeyBackupType

type KeyBackupType int

const (
	PASSWORD KeyBackupType = 0
	GOOGLE   KeyBackupType = 1
	TWITTER  KeyBackupType = 2
	EMAIL    KeyBackupType = 3
)

func (KeyBackupType) String

func (b KeyBackupType) String() string

type KeyPair

type KeyPair struct {
	PublicKey  string
	PrivateKey string
}

type Member

type Member struct {
	Address   string `json:"address"`
	PublicKey string `json:"publicKey"`
}

type MessageBody

type MessageBody struct {
	Type NotificationTypes `json:"type"`
	Body []byte            `json:"body"`
}

type MirrorFile

type MirrorFile struct {
	Path              string
	BucketSlug        string
	Backup            bool
	Shared            bool
	BackupInProgress  bool
	RestoreInProgress bool
}

type Notification

type Notification struct {
	ID               string            `json:"id"`
	Subject          string            `json:"subject"`
	Body             string            `json:"body"`
	NotificationType NotificationTypes `json:"notificationType"`
	CreatedAt        int64             `json:"createdAt"`
	ReadAt           int64             `json:"readAt"`
	// QUESTION: is there a way to enforce that only one of the below is present
	InvitationValue        Invitation        `json:"invitationValue"`
	UsageAlertValue        UsageAlert        `json:"usageAlertValue"`
	InvitationAcceptValue  InvitationReply   `json:"invitationAcceptValue"`
	RevokedInvitationValue RevokedInvitation `json:"revokedInvitationValue"`
	RelatedObject          interface{}       `json:"relatedObject"`
}

type NotificationTypes

type NotificationTypes int

const (
	UNKNOWN NotificationTypes = iota
	INVITATION
	USAGEALERT
	INVITATION_REPLY
	REVOKED_INVITATION
)

type OpenFileInfo

type OpenFileInfo struct {
	Location string
}

type RevokedInvitation

type RevokedInvitation struct {
	InviterPublicKey string     `json:"inviterPublicKey"`
	InviteePublicKey string     `json:"inviteePublicKey"`
	ItemPaths        []FullPath `json:"itemPaths"`
	Keys             [][]byte   `json:"keys"`
}

Represents when an inviter unshared access to previously shared files in ItemPaths

type SearchFileEntry

type SearchFileEntry struct {
	FileInfo
	Bucket string
	DbID   string
}

type SharedDirEntry

type SharedDirEntry struct {
	DbID         string
	Bucket       string
	IsPublicLink bool
	FileInfo
	Members  []Member // XXX: it is duplicated from FileInfo
	SharedBy string
}

type SharedFilesRoleAction

type SharedFilesRoleAction int

SharedFilesRoleAction represents action to be performed on the role

const (
	DeleteRoleAction SharedFilesRoleAction = iota
	ReadWriteRoleAction
)

type ThreadInfo

type ThreadInfo struct {
	Addresses []string
	Key       string
}

type UsageAlert

type UsageAlert struct {
	Used    int64  `json:"used"`
	Limit   int64  `json:"limit"`
	Message string `json:"message"`
}