doaramacli

Documentation

Overview

Package doaramacli provides integration between github.com/twpayne/go-doarama and github.com/urfave/cli.

Index

• Variables
• func ActivityType(c *cli.Context) string
• func BaseDoaramaOptions(c *cli.Context) []doarama.ClientOption
• func NewAuthenticatedDoaramaClient(c *cli.Context) (*doarama.Client, error)
• func NewAuthenticatedDoaramaOptions(c *cli.Context) ([]doarama.ClientOption, error)
• func NewDoaramaClient(c *cli.Context) *doarama.Client
• func NewVisualisationURLOptions(c *cli.Context) *doarama.VisualisationURLOptions

Variables

var ActivityTypeFlag = cli.StringFlag{
	Name:  "activitytype",
	Usage: "activity type",
}

ActivityTypeFlag specifies the activity type.

var Flags = []cli.Flag{
	cli.StringFlag{
		Name:   "apiurl",
		Value:  doarama.DefaultAPIURL,
		Usage:  "Doarama API URL",
		EnvVar: "DOARAMA_API_URL",
	},
	cli.StringFlag{
		Name:   "apikey",
		Usage:  "Doarama API key",
		EnvVar: "DOARAMA_API_KEY",
	},
	cli.StringFlag{
		Name:   "apiname",
		Usage:  "Doarama API name",
		EnvVar: "DOARAMA_API_NAME",
	},
	cli.StringFlag{
		Name:   "userid",
		Usage:  "Doarama user ID",
		EnvVar: "DOARAMA_USER_ID",
	},
	cli.StringFlag{
		Name:   "userkey",
		Usage:  "Doarama user key",
		EnvVar: "DOARAMA_USER_KEY",
	},
}

Flags specify connection and authentication options.

var VisualisationFlags = []cli.Flag{
	cli.StringSliceFlag{
		Name:  "name",
		Usage: "name",
	},
	cli.StringSliceFlag{
		Name:  "avatar",
		Usage: "avatar",
	},
	cli.StringFlag{
		Name:  "avatarbaseurl",
		Usage: "avatar base URL",
	},
	cli.BoolFlag{
		Name:  "fixedaspect",
		Usage: "fixed aspect",
	},
	cli.BoolFlag{
		Name:  "minimalview",
		Usage: "minimal view",
	},
	cli.StringFlag{
		Name:  "dzml",
		Usage: "DZML",
	},
}

VisualisationFlags specify visualisation options.

Functions

func ActivityType

func ActivityType(c *cli.Context) string

ActivityType returns the activity type from c.

func BaseDoaramaOptions

func BaseDoaramaOptions(c *cli.Context) []doarama.ClientOption

BaseDoaramaOptions returns the doarama.Options from c.

func NewAuthenticatedDoaramaClient

func NewAuthenticatedDoaramaClient(c *cli.Context) (*doarama.Client, error)

NewAuthenticatedDoaramaClient returns a new authenticated doarama.Client from c.

func NewAuthenticatedDoaramaOptions

func NewAuthenticatedDoaramaOptions(c *cli.Context) ([]doarama.ClientOption, error)

NewAuthenticatedDoaramaOptions returns the doaram.Options for an authenticated doarama.Client from c.

func NewDoaramaClient

func NewDoaramaClient(c *cli.Context) *doarama.Client

NewDoaramaClient returns a new doarama.Client constructed from c.

func NewVisualisationURLOptions

func NewVisualisationURLOptions(c *cli.Context) *doarama.VisualisationURLOptions

NewVisualisationURLOptions returns a new doarama.VisualisationURLOptions from c.