tag

Documentation

Overview

Package tag provides the /tags APIs

Index

• Constants
• func Delete(ctx context.Context, tagId string) error
• func Get(ctx context.Context, tagId string, params *trimmer.TagParams) (*trimmer.Tag, error)
• func ParseTagLabel(s string) trimmer.TagLabel
• func Reply(ctx context.Context, tagId string, params *trimmer.TagParams) (*trimmer.Tag, error)
• func Update(ctx context.Context, tagId string, params *trimmer.TagParams) (*trimmer.Tag, error)
• type Client
  • func (c Client) Delete(ctx context.Context, tagId string) error
  • func (c Client) Get(ctx context.Context, tagId string, params *trimmer.TagParams) (*trimmer.Tag, error)
  • func (c Client) ListReplies(ctx context.Context, tagId string, params *trimmer.TagListParams) *Iter
  • func (c Client) Reply(ctx context.Context, tagId string, params *trimmer.TagParams) (*trimmer.Tag, error)
  • func (c Client) Update(ctx context.Context, tagId string, params *trimmer.TagParams) (*trimmer.Tag, error)
• type Iter
  • func ListReplies(ctx context.Context, tagId string, params *trimmer.TagListParams) *Iter
  • func (i *Iter) Tag() *trimmer.Tag

Constants

const (
	TagLabelUndefined    trimmer.TagLabel = ""
	TagLabelBlack        trimmer.TagLabel = "black"
	TagLabelChapter      trimmer.TagLabel = "chapter"
	TagLabelComment      trimmer.TagLabel = "comment"
	TagLabelEvent        trimmer.TagLabel = "event"
	TagLabelFavorite     trimmer.TagLabel = "favorite"
	TagLabelFrameData    trimmer.TagLabel = "framedata"
	TagLabelKeyword      trimmer.TagLabel = "keyword"
	TagLabelLds          trimmer.TagLabel = "lds"
	TagLabelNote         trimmer.TagLabel = "note"
	TagLabelOrganization trimmer.TagLabel = "organization"
	TagLabelPerson       trimmer.TagLabel = "person"
	TagLabelPlace        trimmer.TagLabel = "place"
	TagLabelProduct      trimmer.TagLabel = "product"
	TagLabelQuote        trimmer.TagLabel = "quote"
	TagLabelRating       trimmer.TagLabel = "rating"
	TagLabelScenecut     trimmer.TagLabel = "scenecut"
	TagLabelSilence      trimmer.TagLabel = "silence"
	TagLabelTask         trimmer.TagLabel = "task"
	TagLabelText         trimmer.TagLabel = "text"
)

Functions

func Delete

func Delete(ctx context.Context, tagId string) error

func Get

func Get(ctx context.Context, tagId string, params *trimmer.TagParams) (*trimmer.Tag, error)

func ParseTagLabel

func ParseTagLabel(s string) trimmer.TagLabel

func Reply

func Reply(ctx context.Context, tagId string, params *trimmer.TagParams) (*trimmer.Tag, error)

func Update

func Update(ctx context.Context, tagId string, params *trimmer.TagParams) (*trimmer.Tag, error)

Types

type Client

type Client struct {
	B    trimmer.Backend
	Key  trimmer.ApiKey
	Sess *trimmer.Session
}

Client is used to invoke /users APIs.

func (Client) Delete

func (c Client) Delete(ctx context.Context, tagId string) error

func (Client) Get

func (c Client) Get(ctx context.Context, tagId string, params *trimmer.TagParams) (*trimmer.Tag, error)

func (Client) ListReplies

func (c Client) ListReplies(ctx context.Context, tagId string, params *trimmer.TagListParams) *Iter

func (Client) Reply

func (c Client) Reply(ctx context.Context, tagId string, params *trimmer.TagParams) (*trimmer.Tag, error)

func (Client) Update

func (c Client) Update(ctx context.Context, tagId string, params *trimmer.TagParams) (*trimmer.Tag, error)

type Iter

type Iter struct {
	*trimmer.Iter
}

Iter is an iterator for lists of Tags. The embedded Iter carries methods with it; see its documentation for details.

func ListReplies

func ListReplies(ctx context.Context, tagId string, params *trimmer.TagListParams) *Iter

func (*Iter) Tag

func (i *Iter) Tag() *trimmer.Tag

Tag returns the most recent Tag visited by a call to Next.