favorites

Documentation

Index

• type Data
  • func DataFrom(folder keybase1.Folder) Data
• type Folder
  • func NewFolderFromProtocol(folder keybase1.Folder) *Folder
  • func (f Folder) ToKBFolder(created bool) keybase1.Folder
• type ToAdd
  • func (ta ToAdd) ToKBFolder() keybase1.Folder

Types

type Data

type Data struct {
	Name         string
	FolderType   keybase1.FolderType
	Private      bool
	TeamID       *keybase1.TeamID
	ResetMembers []keybase1.User
}

Data represents the auxiliary data belonging to a KBFS favorite.

func DataFrom

func DataFrom(folder keybase1.Folder) Data

DataFrom returns auxiliary data from a folder sent via the keybase1 protocol.

type Folder

type Folder struct {
	Name string
	Type tlf.Type
}

Folder is a top-level favorited folder name.

func NewFolderFromProtocol

func NewFolderFromProtocol(folder keybase1.Folder) *Folder

NewFolderFromProtocol creates a Folder from a keybase1.Folder.

func (Folder) ToKBFolder

func (f Folder) ToKBFolder(created bool) keybase1.Folder

ToKBFolder creates a keybase1.Folder from a Folder.

type ToAdd

type ToAdd struct {
	Folder Folder
	Data   Data

	// Created, if set to true, indicates that this is the first time
	// the TLF has ever existed. It is only used when adding the TLF
	// to favorites
	Created bool
}

ToAdd contains the data needed to add a new favorite to the favorites list.

func (ToAdd) ToKBFolder

func (ta ToAdd) ToKBFolder() keybase1.Folder

ToKBFolder converts this data into an object suitable for the keybase1 protocol.