Help us shape the future of Go! Take the 2026 Go Developer Survey

settings

package
v6.0.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jan 26, 2022 License: MIT Imports: 6 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Client

type Client interface {
	// [Preview API] Get all setting entries for the given user/all-users scope
	GetEntries(context.Context, GetEntriesArgs) (*map[string]interface{}, error)
	// [Preview API] Get all setting entries for the given named scope
	GetEntriesForScope(context.Context, GetEntriesForScopeArgs) (*map[string]interface{}, error)
	// [Preview API] Remove the entry or entries under the specified path
	RemoveEntries(context.Context, RemoveEntriesArgs) error
	// [Preview API] Remove the entry or entries under the specified path
	RemoveEntriesForScope(context.Context, RemoveEntriesForScopeArgs) error
	// [Preview API] Set the specified setting entry values for the given user/all-users scope
	SetEntries(context.Context, SetEntriesArgs) error
	// [Preview API] Set the specified entries for the given named scope
	SetEntriesForScope(context.Context, SetEntriesForScopeArgs) error
}

func NewClient

func NewClient(ctx context.Context, connection *azuredevops.Connection) Client

type ClientImpl

type ClientImpl struct {
	Client azuredevops.Client
}

func (*ClientImpl) GetEntries

func (client *ClientImpl) GetEntries(ctx context.Context, args GetEntriesArgs) (*map[string]interface{}, error)

[Preview API] Get all setting entries for the given user/all-users scope

func (*ClientImpl) GetEntriesForScope

func (client *ClientImpl) GetEntriesForScope(ctx context.Context, args GetEntriesForScopeArgs) (*map[string]interface{}, error)

[Preview API] Get all setting entries for the given named scope

func (*ClientImpl) RemoveEntries

func (client *ClientImpl) RemoveEntries(ctx context.Context, args RemoveEntriesArgs) error

[Preview API] Remove the entry or entries under the specified path

func (*ClientImpl) RemoveEntriesForScope

func (client *ClientImpl) RemoveEntriesForScope(ctx context.Context, args RemoveEntriesForScopeArgs) error

[Preview API] Remove the entry or entries under the specified path

func (*ClientImpl) SetEntries

func (client *ClientImpl) SetEntries(ctx context.Context, args SetEntriesArgs) error

[Preview API] Set the specified setting entry values for the given user/all-users scope

func (*ClientImpl) SetEntriesForScope

func (client *ClientImpl) SetEntriesForScope(ctx context.Context, args SetEntriesForScopeArgs) error

[Preview API] Set the specified entries for the given named scope

type GetEntriesArgs

type GetEntriesArgs struct {
	// (required) User-Scope at which to get the value. Should be "me" for the current user or "host" for all users.
	UserScope *string
	// (optional) Optional key under which to filter all the entries
	Key *string
}

Arguments for the GetEntries function

type GetEntriesForScopeArgs

type GetEntriesForScopeArgs struct {
	// (required) User-Scope at which to get the value. Should be "me" for the current user or "host" for all users.
	UserScope *string
	// (required) Scope at which to get the setting for (e.g. "project" or "team")
	ScopeName *string
	// (required) Value of the scope (e.g. the project or team id)
	ScopeValue *string
	// (optional) Optional key under which to filter all the entries
	Key *string
}

Arguments for the GetEntriesForScope function

type RemoveEntriesArgs

type RemoveEntriesArgs struct {
	// (required) User-Scope at which to remove the value. Should be "me" for the current user or "host" for all users.
	UserScope *string
	// (required) Root key of the entry or entries to remove
	Key *string
}

Arguments for the RemoveEntries function

type RemoveEntriesForScopeArgs

type RemoveEntriesForScopeArgs struct {
	// (required) User-Scope at which to remove the value. Should be "me" for the current user or "host" for all users.
	UserScope *string
	// (required) Scope at which to get the setting for (e.g. "project" or "team")
	ScopeName *string
	// (required) Value of the scope (e.g. the project or team id)
	ScopeValue *string
	// (required) Root key of the entry or entries to remove
	Key *string
}

Arguments for the RemoveEntriesForScope function

type SetEntriesArgs

type SetEntriesArgs struct {
	// (required) The entries to set
	Entries *map[string]interface{}
	// (required) User-Scope at which to set the values. Should be "me" for the current user or "host" for all users.
	UserScope *string
}

Arguments for the SetEntries function

type SetEntriesForScopeArgs

type SetEntriesForScopeArgs struct {
	// (required) The entries to set
	Entries *map[string]interface{}
	// (required) User-Scope at which to set the values. Should be "me" for the current user or "host" for all users.
	UserScope *string
	// (required) Scope at which to set the settings on (e.g. "project" or "team")
	ScopeName *string
	// (required) Value of the scope (e.g. the project or team id)
	ScopeValue *string
}

Arguments for the SetEntriesForScope function

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL