confluence

package

v0.3.4 Latest Latest Go to latest Published: Jun 24, 2026 License: MIT Imports: 9 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/MiviaLabs/go-mivia

Links

Open Source Insights

Documentation ¶

Index ¶

type Client
- func NewClient(options Options) Client
- func (client Client) GetPage(ctx context.Context, credentials projectintegrations.Credentials, ...) (PageResponse, error)
- func (client Client) SearchPages(ctx context.Context, credentials projectintegrations.Credentials, cql string, ...) (SearchResponse, error)
type Options
type PageResponse
type Poller
- func NewPoller(client Client) Poller
- func (poller Poller) PollConfluence(ctx context.Context, credentials projectintegrations.Credentials, ...) (projectintegrations.PollResult, error)
- func (poller Poller) PollConfluenceWithProgress(ctx context.Context, credentials projectintegrations.Credentials, ...) (projectintegrations.PollResult, error)
type SearchResponse
- func (response SearchResponse) NextCursor() string

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Client ¶

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

func NewClient ¶

func NewClient(options Options) Client

func (Client) GetPage ¶

func (client Client) GetPage(ctx context.Context, credentials projectintegrations.Credentials, pageID string, bodyRepresentation string) (PageResponse, error)

func (Client) SearchPages ¶

func (client Client) SearchPages(ctx context.Context, credentials projectintegrations.Credentials, cql string, limit int, cursor ...string) (SearchResponse, error)

type Options ¶

type Options struct {
	BaseURL    string
	HTTPClient *http.Client
	Timeout    time.Duration
}

type PageResponse ¶

type PageResponse struct {
	Raw json.RawMessage
}

type Poller ¶

type Poller struct {
	Client Client
}

func NewPoller ¶

func NewPoller(client Client) Poller

func (Poller) PollConfluence ¶

func (poller Poller) PollConfluence(ctx context.Context, credentials projectintegrations.Credentials, plan projectintegrations.ConfluenceQueryPlan) (projectintegrations.PollResult, error)

func (Poller) PollConfluenceWithProgress ¶

func (poller Poller) PollConfluenceWithProgress(ctx context.Context, credentials projectintegrations.Credentials, plan projectintegrations.ConfluenceQueryPlan, progress projectintegrations.PollProgressFunc) (projectintegrations.PollResult, error)

type SearchResponse ¶

type SearchResponse struct {
	Results []json.RawMessage `json:"results"`
	Links   map[string]string `json:"_links,omitempty"`
}

func (SearchResponse) NextCursor ¶

func (response SearchResponse) NextCursor() string

Source Files ¶

View all Source files

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