commentapi

Documentation

Index

• func Create(params CreateParams) (string, error)
• func Delete(params DeleteParams) error
• func Get(params GetParams) (*models.Comment, error)
• func List(params ListParams) (*models.CommentsWithMetas, error)
• func Update(params UpdateParams) (string, error)
• type CreateParams
  • func (params CreateParams) Validate() error
• type DeleteParams
  • func (params DeleteParams) Validate() error
• type GetParams
  • func (params GetParams) Validate() error
• type ListParams
  • func (params ListParams) Validate() error
• type UpdateParams
  • func (params UpdateParams) Validate() error

Functions

func Create

func Create(params CreateParams) (string, error)

Create creates a comment to the given resource and returns a reference ID.

func Delete

func Delete(params DeleteParams) error

Delete delete the comment of the given combination of comment ID, version, resource type and resource ID.

func Get

func Get(params GetParams) (*models.Comment, error)

Get fetches the comment of the given combination of comment ID, resource type and resource ID.

func List

func List(params ListParams) (*models.CommentsWithMetas, error)

List fetches the comment of the given combination of comment ID, resource type and resource ID.

func Update

func Update(params UpdateParams) (string, error)

Update creates a comment to the given resource and returns a reference ID.

Types

type CreateParams

type CreateParams struct {
	*api.API
	ResourceType, ResourceID, Message, Region string
}

CreateParams is consumed by the Create function.

func (CreateParams) Validate

func (params CreateParams) Validate() error

Validate ensures the parameters are usable by Create.

type DeleteParams

type DeleteParams struct {
	*api.API
	ResourceType, ResourceID, CommentID, Region, Version string
}

DeleteParams is consumed by the Delete function.

func (DeleteParams) Validate

func (params DeleteParams) Validate() error

Validate ensures the parameters are usable by Delete.

type GetParams

type GetParams struct {
	*api.API
	ResourceType, ResourceID, CommentID, Region string
}

GetParams is consumed by the Get function.

func (GetParams) Validate

func (params GetParams) Validate() error

Validate ensures the parameters are usable by Get.

type ListParams

type ListParams struct {
	*api.API
	ResourceType, ResourceID, Region string
}

ListParams is consumed by the List function.

func (ListParams) Validate

func (params ListParams) Validate() error

Validate ensures the parameters are usable by List.

type UpdateParams

type UpdateParams struct {
	*api.API
	ResourceType, ResourceID, Message, CommentID, Version, Region string
}

UpdateParams is consumed by the Update function.

func (UpdateParams) Validate

func (params UpdateParams) Validate() error

Validate ensures the parameters are usable by Update.