client

Documentation

Index

• type ConfluenceClient
  • func Client(config *ConfluenceConfig) *ConfluenceClient
  • func (c *ConfluenceClient) AddAttachment(content, pageID, filename string)
  • func (c *ConfluenceClient) AddPage(title, spaceKey, body string, ancestor int64)
  • func (c *ConfluenceClient) ConvertToStorage(body, sourceFormat, title, spaceKey string) string
  • func (c *ConfluenceClient) SearchPages(title, spaceKey string) (results *ConfluencePageSearch)
  • func (c *ConfluenceClient) UpdatePage(title, spaceKey, body string, ID string, version, ancestor int64)
• type ConfluenceConfig
• type ConfluenceConvert
• type ConfluencePage
• type ConfluencePageAncestor
• type ConfluencePageBody
• type ConfluencePageBodyStorage
• type ConfluencePageSearch
• type ConfluencePageVersion
• type ConfluenceSpace
• type TinyMceRequest

Types

type ConfluenceClient

type ConfluenceClient struct {
	// contains filtered or unexported fields
}

ConfluenceClient is the primary client to the Confluence API

func Client

func Client(config *ConfluenceConfig) *ConfluenceClient

Client returns a new instance of the client

func (*ConfluenceClient) AddAttachment

func (c *ConfluenceClient) AddAttachment(content, pageID, filename string)

AddAttachment adds an attachment to an existing page

func (*ConfluenceClient) AddPage

func (c *ConfluenceClient) AddPage(title, spaceKey, body string, ancestor int64)

AddPage adds a new page to the space with the given title

func (*ConfluenceClient) ConvertToStorage

func (c *ConfluenceClient) ConvertToStorage(body, sourceFormat, title, spaceKey string) string

ConvertToStorage returns the supplied text in storage format

func (*ConfluenceClient) SearchPages

func (c *ConfluenceClient) SearchPages(title, spaceKey string) (results *ConfluencePageSearch)

SearchPages searches for pages in the space that meet the specified criteria

func (*ConfluenceClient) UpdatePage

func (c *ConfluenceClient) UpdatePage(title, spaceKey, body string, ID string, version, ancestor int64)

UpdatePage adds a new page to the space with the given title

type ConfluenceConfig

type ConfluenceConfig struct {
	Username string
	Password string
	URL      string
	Debug    bool
}

ConfluenceConfig holds the current client configuration

type ConfluenceConvert

type ConfluenceConvert struct {
	Value          string `json:"value,omitempty"`
	Representation string `json:"representation,omitempty"`
}

ConfluenceConvert is used to store the conversion request or result for a convert command

type ConfluencePage

type ConfluencePage struct {
	Title     string                   `json:"title,omitempty"`
	Type      string                   `json:"type,omitempty"`
	ID        string                   `json:"id,omitempty"`
	Ancestors []ConfluencePageAncestor `json:"ancestors,omitempty"`
	Space     *ConfluenceSpace         `json:"space,omitempty"`
	Body      *ConfluencePageBody      `json:"body,omitempty"`
	Version   *ConfluencePageVersion   `json:"version,omitempty"`
}

ConfluencePage stores the base page object

type ConfluencePageAncestor

type ConfluencePageAncestor struct {
	ID int64 `json:"id,omitempty"`
}

ConfluencePageAncestor holds the ID of a specific ancestor to a confluence page

type ConfluencePageBody

type ConfluencePageBody struct {
	Storage *ConfluencePageBodyStorage `json:"storage,omitempty"`
}

ConfluencePageBody holds the page contents itself

type ConfluencePageBodyStorage

type ConfluencePageBodyStorage struct {
	Value          string `json:"value,omitempty"`
	Representation string `json:"representation,omitempty"`
}

ConfluencePageBodyStorage holds the storage objects of the body

type ConfluencePageSearch

type ConfluencePageSearch struct {
	Results []ConfluencePage `json:"results,omitempty"`
	Start   int64            `json:"start,omitempty"`
	Limit   int64            `json:"limit,omitempty"`
	Size    int64            `json:"size,omitempty"`
}

ConfluencePageSearch stores search results for checking existing pages

type ConfluencePageVersion

type ConfluencePageVersion struct {
	Number int64 `json:"number,omitempty"`
}

ConfluencePageVersion holds the version information for a page

type ConfluenceSpace

type ConfluenceSpace struct {
	ID   int64  `json:"id,omitempty"`
	Key  string `json:"key,omitempty"`
	Name string `json:"name,omitempty"`
}

ConfluenceSpace stores the space information

type TinyMceRequest

type TinyMceRequest struct {
	EntityID string `json:"entityId,omitempty"`
	SpaceKey string `json:"spaceKey,omitempty"`
	Wiki     string `json:"wiki,omitempty"`
}

TinyMceRequest is used for the undocumented TineMCE API