sv_teamfolder

Documentation

Index

• Constants
• Variables
• func IsNotFound(err error) bool
• type CreateOption
  • func SyncDefault() CreateOption
  • func SyncNoSync() CreateOption
• type NestedSyncSetting
• type SyncSettingOpt
  • func AddNestedSetting(folder mo_file.Entry, setting string) SyncSettingOpt
  • func RootSyncSetting(setting string) SyncSettingOpt
• type SyncSettingsOpts
  • func (z SyncSettingsOpts) Apply(opts []SyncSettingOpt) SyncSettingsOpts
• type TeamFolder
  • func New(ctx dbx_context.Context) TeamFolder
  • func NewCached(ctx dbx_context.Context) TeamFolder

Constants

const (
	SyncSettingSkipSetting = ""
	SyncSettingDefault     = "default"
	SyncSettingNotSynced   = "not_synced"
)

Variables

var (
	ErrorTeamFolderNotFound = errors.New("team folder not found")
)

Functions

func IsNotFound

func IsNotFound(err error) bool

Types

type CreateOption

type CreateOption func(opt *createOptions) *createOptions

func SyncDefault

func SyncDefault() CreateOption

func SyncNoSync

func SyncNoSync() CreateOption

type NestedSyncSetting

type NestedSyncSetting struct {
	FolderId    string `json:"id"`
	SyncSetting string `json:"sync_setting"`
}

type SyncSettingOpt

type SyncSettingOpt func(o SyncSettingsOpts) SyncSettingsOpts

func AddNestedSetting

func AddNestedSetting(folder mo_file.Entry, setting string) SyncSettingOpt

func RootSyncSetting

func RootSyncSetting(setting string) SyncSettingOpt

type SyncSettingsOpts

type SyncSettingsOpts struct {
	TeamFolderId        string              `json:"team_folder_id"`
	SyncSetting         string              `json:"sync_setting,omitempty"`
	ContentSyncSettings []NestedSyncSetting `json:"content_sync_settings,omitempty"`
}

func (SyncSettingsOpts) Apply

func (z SyncSettingsOpts) Apply(opts []SyncSettingOpt) SyncSettingsOpts

type TeamFolder

type TeamFolder interface {
	// Retrieve all team folders of the team.
	List() (teamfolders []*mo_teamfolder.TeamFolder, err error)

	// Resolve team folder with team_folder_id.
	// Please use IsNotFound to make sure if an error was not_found error or not.
	Resolve(teamFolderId string) (teamfolder *mo_teamfolder.TeamFolder, err error)

	// Resolve team folder with team folder name.
	// Please use IsNotFound to make sure if an error was not_found error or not.
	ResolveByName(teamFolderName string) (teamfolder *mo_teamfolder.TeamFolder, err error)

	// Create a team folder.
	Create(name string, opts ...CreateOption) (teamfolder *mo_teamfolder.TeamFolder, err error)

	// Activate a team folder from archive.
	Activate(tf *mo_teamfolder.TeamFolder) (teamfolder *mo_teamfolder.TeamFolder, err error)

	// Archive a team folder.
	Archive(tf *mo_teamfolder.TeamFolder) (teamfolder *mo_teamfolder.TeamFolder, err error)

	// Rename the team folder.
	Rename(tf *mo_teamfolder.TeamFolder, newName string) (updated *mo_teamfolder.TeamFolder, err error)

	// Permanently delete archived team folder.
	PermDelete(tf *mo_teamfolder.TeamFolder) (err error)

	// Update sync setting
	UpdateSyncSetting(tf *mo_teamfolder.TeamFolder, opts ...SyncSettingOpt) (teamfolder *mo_teamfolder.TeamFolder, err error)
}

func New

func New(ctx dbx_context.Context) TeamFolder

func NewCached

func NewCached(ctx dbx_context.Context) TeamFolder