image

package
v0.22.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 11, 2021 License: Apache-2.0 Imports: 1 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type ConvertRequest

type ConvertRequest struct {
	// base64 encoded image to resize,
	Base64 string `json:"base64"`
	// The image file to convert
	File string `json:"file"`
	// output name of the image including extension, ie. "cat.png"
	Name string `json:"name"`
	// make output a URL and not a base64 response
	OutputUrl bool `json:"outputUrl"`
	// url of the image to resize
	Url string `json:"url"`
}

type ConvertResponse

type ConvertResponse struct {
	Base64 string `json:"base64"`
	Url    string `json:"url"`
}

type CropOptions

type CropOptions struct {
	// Crop anchor point: "top", "top left", "top right",
	// "left", "center", "right"
	// "bottom left", "bottom", "bottom right".
	// Optional. Defaults to center.
	Anchor string `json:"anchor"`
	// height to crop to
	Height int32 `json:"height"`
	// width to crop to
	Width int32 `json:"width"`
}

type DeleteRequest added in v0.22.0

type DeleteRequest struct {
	// url of the image to delete e.g. https://cdn.m3ocontent.com/micro/images/micro/41e23b39-48dd-42b6-9738-79a313414bb8/cat.jpeg
	Url string `json:"url"`
}

type DeleteResponse added in v0.22.0

type DeleteResponse struct {
}

type ImageService

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

func NewImageService

func NewImageService(token string) *ImageService

func (*ImageService) Convert

func (t *ImageService) Convert(request *ConvertRequest) (*ConvertResponse, error)

Convert an image from one format (jpeg, png etc.) to an other either on the fly (from base64 to base64), or by uploading the conversion result. To use the file parameter you need to send the request as a multipart/form-data rather than the usual application/json with each parameter as a form field.

func (*ImageService) Delete added in v0.22.0

func (t *ImageService) Delete(request *DeleteRequest) (*DeleteResponse, error)

Delete an image previously uploaded.

func (*ImageService) Resize

func (t *ImageService) Resize(request *ResizeRequest) (*ResizeResponse, error)

Resize an image on the fly without storing it (by sending and receiving a base64 encoded image), or resize and upload depending on parameters. If one of width or height is 0, the image aspect ratio is preserved. Optional cropping. To use the file parameter you need to send the request as a multipart/form-data rather than the usual application/json with each parameter as a form field.

func (*ImageService) Upload

func (t *ImageService) Upload(request *UploadRequest) (*UploadResponse, error)

Upload an image by either sending a base64 encoded image to this endpoint or a URL. To resize an image before uploading, see the Resize endpoint. To use the file parameter you need to send the request as a multipart/form-data rather than the usual application/json with each parameter as a form field.

type Point

type Point struct {
	X int32 `json:"x"`
	Y int32 `json:"y"`
}

type Rectangle

type Rectangle struct {
	Max *Point `json:"max"`
	Min *Point `json:"min"`
}

type ResizeRequest

type ResizeRequest struct {
	// base64 encoded image to resize,
	Base64 string `json:"base64"`
	// optional crop options
	// if provided, after resize, the image
	// will be cropped
	CropOptions *CropOptions `json:"cropOptions"`
	// The image file to resize
	File   string `json:"file"`
	Height int64  `json:"height,string"`
	// output name of the image including extension, ie. "cat.png"
	Name string `json:"name"`
	// make output a URL and not a base64 response
	OutputUrl bool `json:"outputUrl"`
	// url of the image to resize
	Url   string `json:"url"`
	Width int64  `json:"width,string"`
}

type ResizeResponse

type ResizeResponse struct {
	Base64 string `json:"base64"`
	Url    string `json:"url"`
}

type UploadRequest

type UploadRequest struct {
	// Base64 encoded image to upload,
	Base64 string `json:"base64"`
	// The image file to upload
	File string `json:"file"`
	// Output name of the image including extension, ie. "cat.png"
	Name string `json:"name"`
	// URL of the image to upload
	Url string `json:"url"`
}

type UploadResponse

type UploadResponse struct {
	Url string `json:"url"`
}

Jump to

Keyboard shortcuts

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