viewer

package module
v1.25.4 Latest Latest
Warning

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

 Go to latest Published: Apr 14, 2025 License: MIT Imports: 22 Imported by: 0

README

GroupDocs.Viewer Cloud Go SDK

Go package for communicating with the GroupDocs.Viewer Cloud API

Installation

The package is available at github.com. You can install it with:

go get github.com/groupdocs-viewer-cloud/groupdocs-viewer-cloud-go

To add dependency to your app copy following into your go.mod and run go mod tidy:

require (
 github.com/groupdocs-viewer-cloud/groupdocs-viewer-cloud-go v1.0.0
)

Getting Started

Please follow the installation procedure and then run the following code:

package main

import (
 "context"
 "fmt"

 "github.com/antihax/optional"
 viewer "github.com/groupdocs-viewer-cloud/groupdocs-viewer-cloud-go"
 "golang.org/x/oauth2/clientcredentials"
)

func main() {

 // Create an OAuth2 config using client_credentials grant type
 conf := &clientcredentials.Config{
  ClientID:     "XXXX-XXXX-XXXX-XXXX",      // Your client_id
  ClientSecret: "XXXXXXXXXXXXXXXX",          // Your client_secret
  TokenURL:     "https://api.groupdocs.cloud/connect/token", // The token URL
  Scopes:       []string{},                                  // Optional: specify any required scopes
 }

 // Request the token
 token, err := conf.Token(context.Background())
 if err != nil {
  fmt.Printf("Unable to retrieve token: %v", err)
 }

 // Output the access token
 fmt.Printf("Access Token: %s\n", token.AccessToken)

 cfg := viewer.NewConfiguration()
 client := viewer.NewAPIClient(cfg)
 auth := context.WithValue(context.Background(), viewer.ContextAccessToken, token.AccessToken)

result, _, _ := client.InfoApi.GetSupportedFileFormats(auth)

 for _, format := range result.Formats {
  fmt.Printf("%s (%s)\n", format.FileFormat, format.Extension)
 }
}

Licensing

GroupDocs.Viewer Cloud Go SDK licensed under MIT License.

Resources

Contact Us

Your feedback is very important to us. Please feel free to contact us using our Support Forums.

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var (
	// ContextOAuth2 takes a oauth2.TokenSource as authentication for the request.
	ContextOAuth2 = contextKey("token")

	// ContextBasicAuth takes BasicAuth as authentication for the request.
	ContextBasicAuth = contextKey("basic")

	// ContextAccessToken takes a string oauth2 access token as authentication for the request.
	ContextAccessToken = contextKey("accesstoken")

	// ContextAPIKey takes an APIKey as authentication for the request
	ContextAPIKey = contextKey("apikey")
)

Functions

func CacheExpires 

func CacheExpires(r *http.Response) time.Time

CacheExpires helper function to determine remaining time before repeating a request.

Types

type APIClient 

type APIClient struct {
	FileApi *FileApiService

	FolderApi *FolderApiService

	InfoApi *InfoApiService

	LicenseApi *LicenseApiService

	StorageApi *StorageApiService

	ViewApi *ViewApiService
	// contains filtered or unexported fields
}

APIClient manages communication with the GroupDocs.Viewer Cloud API Reference API v25.3 In most cases there should be only one, shared, APIClient.

func NewAPIClient 

func NewAPIClient(cfg *Configuration) *APIClient

NewAPIClient creates a new API client. Requires a userAgent string describing your application. optionally a custom http.Client to allow for advanced features such as caching.

func (*APIClient) ChangeBasePath 

func (c *APIClient) ChangeBasePath(path string)

Change base path to allow switching to mocks

type APIKey 

type APIKey struct {
	Key    string
	Prefix string
}

APIKey provides API key based authentication to a request passed via context using ContextAPIKey

type APIResponse 

type APIResponse struct {
	*http.Response `json:"-"`
	Message        string `json:"message,omitempty"`
	// Operation is the name of the swagger operation.
	Operation string `json:"operation,omitempty"`
	// RequestURL is the request URL. This value is always available, even if the
	// embedded *http.Response is nil.
	RequestURL string `json:"url,omitempty"`
	// Method is the HTTP method used for the request.  This value is always
	// available, even if the embedded *http.Response is nil.
	Method string `json:"method,omitempty"`
	// Payload holds the contents of the response body (which may be nil or empty).
	// This is provided here as the raw response.Body() reader will have already
	// been drained.
	Payload []byte `json:"-"`
}

func NewAPIResponse 

func NewAPIResponse(r *http.Response) *APIResponse

func NewAPIResponseWithError 

func NewAPIResponseWithError(errorMessage string) *APIResponse

type BasicAuth 

type BasicAuth struct {
	UserName string `json:"userName,omitempty"`
	Password string `json:"password,omitempty"`
}

BasicAuth provides basic http authentication to a request passed via context using ContextBasicAuth

type Configuration 

type Configuration struct {
	BasePath      string            `json:"basePath,omitempty"`
	Host          string            `json:"host,omitempty"`
	Scheme        string            `json:"scheme,omitempty"`
	DefaultHeader map[string]string `json:"defaultHeader,omitempty"`
	UserAgent     string            `json:"userAgent,omitempty"`
	HTTPClient    *http.Client
}

func NewConfiguration 

func NewConfiguration() *Configuration

func (*Configuration) AddDefaultHeader 

func (c *Configuration) AddDefaultHeader(key string, value string)

type FileApiCopyFileOpts 

type FileApiCopyFileOpts struct {
	SrcStorageName  optional.String
	DestStorageName optional.String
	VersionId       optional.String
}

type FileApiDeleteFileOpts 

type FileApiDeleteFileOpts struct {
	StorageName optional.String
	VersionId   optional.String
}

type FileApiDownloadFileOpts 

type FileApiDownloadFileOpts struct {
	StorageName optional.String
	VersionId   optional.String
}

type FileApiMoveFileOpts 

type FileApiMoveFileOpts struct {
	SrcStorageName  optional.String
	DestStorageName optional.String
	VersionId       optional.String
}

type FileApiService 

type FileApiService service

func (*FileApiService) CopyFile 

func (a *FileApiService) CopyFile(ctx context.Context, srcPath string, destPath string, localVarOptionals *FileApiCopyFileOpts) (*http.Response, error)

func (*FileApiService) DeleteFile 

func (a *FileApiService) DeleteFile(ctx context.Context, path string, localVarOptionals *FileApiDeleteFileOpts) (*http.Response, error)

func (*FileApiService) DownloadFile 

func (a *FileApiService) DownloadFile(ctx context.Context, path string, localVarOptionals *FileApiDownloadFileOpts) (*os.File, *http.Response, error)

func (*FileApiService) MoveFile 

func (a *FileApiService) MoveFile(ctx context.Context, srcPath string, destPath string, localVarOptionals *FileApiMoveFileOpts) (*http.Response, error)

func (*FileApiService) UploadFile 

func (a *FileApiService) UploadFile(ctx context.Context, path string, file *os.File, localVarOptionals *FileApiUploadFileOpts) (FilesUploadResult, *http.Response, error)

type FileApiUploadFileOpts 

type FileApiUploadFileOpts struct {
	StorageName optional.String
}

type FolderApiCopyFolderOpts 

type FolderApiCopyFolderOpts struct {
	SrcStorageName  optional.String
	DestStorageName optional.String
}

type FolderApiCreateFolderOpts 

type FolderApiCreateFolderOpts struct {
	StorageName optional.String
}

type FolderApiDeleteFolderOpts 

type FolderApiDeleteFolderOpts struct {
	StorageName optional.String
	Recursive   optional.Bool
}

type FolderApiGetFilesListOpts 

type FolderApiGetFilesListOpts struct {
	StorageName optional.String
}

type FolderApiMoveFolderOpts 

type FolderApiMoveFolderOpts struct {
	SrcStorageName  optional.String
	DestStorageName optional.String
}

type FolderApiService 

type FolderApiService service

func (*FolderApiService) CopyFolder 

func (a *FolderApiService) CopyFolder(ctx context.Context, srcPath string, destPath string, localVarOptionals *FolderApiCopyFolderOpts) (*http.Response, error)

func (*FolderApiService) CreateFolder 

func (a *FolderApiService) CreateFolder(ctx context.Context, path string, localVarOptionals *FolderApiCreateFolderOpts) (*http.Response, error)

func (*FolderApiService) DeleteFolder 

func (a *FolderApiService) DeleteFolder(ctx context.Context, path string, localVarOptionals *FolderApiDeleteFolderOpts) (*http.Response, error)

func (*FolderApiService) GetFilesList 

func (a *FolderApiService) GetFilesList(ctx context.Context, path string, localVarOptionals *FolderApiGetFilesListOpts) (FilesList, *http.Response, error)

func (*FolderApiService) MoveFolder 

func (a *FolderApiService) MoveFolder(ctx context.Context, srcPath string, destPath string, localVarOptionals *FolderApiMoveFolderOpts) (*http.Response, error)

type GenericSwaggerError 

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

GenericSwaggerError Provides access to the body, error and model on returned errors.

func (GenericSwaggerError) Body 

func (e GenericSwaggerError) Body() []byte

Body returns the raw bytes of the response

func (GenericSwaggerError) Error 

func (e GenericSwaggerError) Error() string

Error returns non-empty string if there was an error.

func (GenericSwaggerError) Model 

func (e GenericSwaggerError) Model() interface{}

Model returns the unpacked model of the error

type InfoApiService 

type InfoApiService service

func (*InfoApiService) GetInfo 

func (a *InfoApiService) GetInfo(ctx context.Context, viewOptions ViewOptions) (InfoResult, *http.Response, error)

InfoApiService Retrieve information about document pages

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param viewOptions View options

@return InfoResult

func (*InfoApiService) GetSupportedFileFormats 

func (a *InfoApiService) GetSupportedFileFormats(ctx context.Context) (FormatsResult, *http.Response, error)

InfoApiService List supported file formats

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return FormatsResult

type LicenseApiService 

type LicenseApiService service

func (*LicenseApiService) GetConsumptionCredit 

func (a *LicenseApiService) GetConsumptionCredit(ctx context.Context) (ConsumptionResult, *http.Response, error)

LicenseApiService Get license consumption

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return ConsumptionResult

type StorageApiGetDiscUsageOpts 

type StorageApiGetDiscUsageOpts struct {
	StorageName optional.String
}

type StorageApiGetFileVersionsOpts 

type StorageApiGetFileVersionsOpts struct {
	StorageName optional.String
}

type StorageApiObjectExistsOpts 

type StorageApiObjectExistsOpts struct {
	StorageName optional.String
	VersionId   optional.String
}

type StorageApiService 

type StorageApiService service

func (*StorageApiService) GetDiscUsage 

func (a *StorageApiService) GetDiscUsage(ctx context.Context, localVarOptionals *StorageApiGetDiscUsageOpts) (DiscUsage, *http.Response, error)

func (*StorageApiService) GetFileVersions 

func (a *StorageApiService) GetFileVersions(ctx context.Context, path string, localVarOptionals *StorageApiGetFileVersionsOpts) (FileVersions, *http.Response, error)

func (*StorageApiService) ObjectExists 

func (a *StorageApiService) ObjectExists(ctx context.Context, path string, localVarOptionals *StorageApiObjectExistsOpts) (ObjectExist, *http.Response, error)

func (*StorageApiService) StorageExists 

func (a *StorageApiService) StorageExists(ctx context.Context, storageName string) (StorageExist, *http.Response, error)

StorageApiService Check if storage exists

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param storageName Storage name

@return StorageExist

type ViewApiConvertAndDownloadOpts 

type ViewApiConvertAndDownloadOpts struct {
	Pages    optional.String
	Password optional.String
}

type ViewApiService 

type ViewApiService service

func (*ViewApiService) ConvertAndDownload 

func (a *ViewApiService) ConvertAndDownload(ctx context.Context, format string, file *os.File, localVarOptionals *ViewApiConvertAndDownloadOpts) (*os.File, *http.Response, error)

func (*ViewApiService) CreateView 

func (a *ViewApiService) CreateView(ctx context.Context, viewOptions ViewOptions) (ViewResult, *http.Response, error)

ViewApiService Render document pages

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param viewOptions View options

@return ViewResult

func (*ViewApiService) DeleteView 

func (a *ViewApiService) DeleteView(ctx context.Context, deleteViewOptions DeleteViewOptions) (*http.Response, error)

ViewApiService Delete rendered pages

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param deleteViewOptions Delete options

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.