Documentation ¶
Index ¶
- Constants
- Variables
- type API
- func (api *API) About() (About, error)
- func (api *API) CloseWebSocket() error
- func (api *API) Copy(appId, name string) (ApplicationResult, error)
- func (api *API) Create(name, localizedScriptMainSection string) (Response, error)
- func (api *API) CreateSheet(handle int, title, description, thumbnail, id string, rows, columns, rank int) (Response, error)
- func (api *API) DoReload(handle int) (Response, error)
- func (api *API) DoSave(handle int) (Response, error)
- func (api *API) GetActiveDoc() (Response, error)
- func (api *API) GetProgress(handle int, id int) (Response, error)
- func (api *API) GetScript(handle int) (Response, error)
- func (api *API) List() ([]ApplicationResult, error)
- func (api *API) ListStreams() (Response, error)
- func (api *API) Open(name, directory, user string) (Response, error)
- func (api *API) OpenWebSocket() error
- func (api *API) Publish(appId, streamId, name string) (ApplicationResult, error)
- func (api *API) Reload(appId string) error
- func (api *API) SetScript(handle int, script string) (Response, error)
- func (api *API) SetTLSItemLocations(certLocation, keyLocation, caFile string) error
- type About
- type ApplicationResult
- type ChildListDef
- type CreateAppParms
- type CustomProperty
- type Data
- type EngineStream
- type Info
- type MetaDef
- type Owner
- type Params
- type Privileges
- type Request
- func CreateApp(name string) Request
- func CreateAppEx(name string) Request
- func CreateSheet(handle int, params SheetParams) Request
- func DoReload(handle int) Request
- func DoSave(handle int) Request
- func GetActiveDoc() Request
- func GetProgress(handle int, id int) Request
- func GetScript(handle int) Request
- func GetStreamList() Request
- func NewRequest(id int, method string, handle int, params interface{}) Request
- func OpenDoc(name string, user, directory string) Request
- func SetScript(handle int, script string) Request
- type Response
- type Result
- type Return
- type SheetParams
- type SheetParamsEx
- type StaticContentUrlDef
- type Stream
- type Thumbnail
- type WebsocketError
Constants ¶
View Source
const CRLF = "\r\n"
View Source
const DEFAULT_AUTH_PORT = 4243
View Source
const DEFAULT_DIR = "WIN8-VBOX"
View Source
const DEFAULT_QRS_PORT = 4242
View Source
const DEFAULT_SERVER = "192.168.99.5"
View Source
const DEFAULT_USER = "atscale"
View Source
const DEFAULT_WEBSOCKET_PORT = 4747
View Source
const DELETE = "DELETE"
View Source
const GET = "GET"
View Source
const POST = "POST"
View Source
const PUT = "PUT"
Variables ¶
View Source
var API_VERSION = "2.2"
View Source
var ErrDoesNotExist = errors.New("Does Not Exist")
Functions ¶
This section is empty.
Types ¶
type API ¶
type API struct { Server string QrsPort int AuthPort int WebsocketPort int Version string Directory string QlikUser string ClientKey string ClientCert string XrfKey string CertAuth string WebsocketConnection *websocket.Conn }
func DefaultApi ¶
func DefaultApi() API
func (*API) CloseWebSocket ¶
func (*API) CreateSheet ¶
func (*API) GetActiveDoc ¶
func (*API) List ¶
func (api *API) List() ([]ApplicationResult, error)
func (*API) ListStreams ¶
func (*API) OpenWebSocket ¶
func (*API) Publish ¶
func (api *API) Publish(appId, streamId, name string) (ApplicationResult, error)
func (*API) SetTLSItemLocations ¶
type ApplicationResult ¶
type ApplicationResult struct { Id string `json:"id,omitempty"` CreatedDate string `json:"createdDate,omitempty"` ModifiedDate string `json:"modifiedDate,omitempty"` ModifiedByUserName string `json:"modifiedByUserName,omitempty"` CustomProperties []CustomProperty `json:"customProperites,omitempty"` Owner *Owner `json:"owner,omitempty"` Name string `json:"name,omitempty"` AppId string `json:"appId,omitempty"` PublishTime string `json:"publishTime,omitempty"` Published bool `json:"published,omitempty"` Tags []string `json:"tags,omitempty"` Description string `json:"description,omitempty"` Stream *Stream `json:"stream,omitempty"` FileSize int `json:"fileSize,omitempty"` LastReloadTime string `json:"lastReloadTime,omitempty"` Thumbnail string `json:"thumbnail,omitempty"` SavedInProductVersion string `json:"savedInProductVersion,omitempty"` MigrationHash string `json:"migrationHash,omitempty"` Privileges *Privileges `json:"privileges,omitempty"` SchemaPath string `json:"schemaPath,omitempty"` }
type ChildListDef ¶
type ChildListDef struct {
Data *Data `json:"qData,omitempty"`
}
type CreateAppParms ¶
type CreateAppParms struct {
Params
}
type CustomProperty ¶
type CustomProperty struct { }
type Data ¶
type Data struct { Title string `json:"title,omitempty"` Description string `json:"description,omitempty"` Meta string `json:"meta,omitempty"` Order string `json:"order,omitempty"` Type string `json:"type,omitempty"` Id string `json:"id,omitempty"` Lb string `json:"lb,omitempty"` Hc string `json:"hc,omitempty"` }
type EngineStream ¶
type MetaDef ¶
type MetaDef struct { Title string `json:"title,omitempty"` Description string `json:"description,omitempty"` ChildListDef *ChildListDef `json:"qChildListDef,omitempty"` }
type Privileges ¶
type Privileges struct { }
type Request ¶
type Request struct { JsonRPCVersion string `json:"jsonrpc,omitempty"` Id int `json:"id,omitempty"` Method string `json:"method,omitempty"` Handle int `json:"handle,omitempty"` Delta bool `json:"delta,omitempty"` Params interface{} `json:"params"` }
func CreateAppEx ¶
func CreateSheet ¶
func CreateSheet(handle int, params SheetParams) Request
func GetActiveDoc ¶
func GetActiveDoc() Request
func GetProgress ¶
func GetStreamList ¶
func GetStreamList() Request
type Response ¶
type Response struct { JsonRPCVersion string `json:"jsonrpc,omitempty"` Id int `json:"id"` Result *Result `json:"result,omitempty"` Error *WebsocketError `json:"error,omitempty"` Change []int `json:"change"` }
type Result ¶
type Result struct { Success bool `json:"qSuccess,omitempty"` AppId string `json:"qAppId,omitempty"` Type string `json:"qType,omitempty"` Handle int `json:"qHandle,omitempty"` Script string `json:"qScript,omitempty"` StreamList []EngineStream `json:"qStreamList,omitempty"` Return Return `json:"qReturn,omitempty"` }
type SheetParams ¶
type SheetParams struct { MetaDef *MetaDef `json:"qMetaDef,omitempty"` Rank int `json:"rank,omitempty"` Thumbnail *Thumbnail `json:"thumbnail,omitempty"` Columns int `json:"columns,omitempty"` Rows int `json:"rows,omitempty"` Cells []string `json:"cells"` Info *Info `json:"qInfo,omitempty"` }
func CreateSheetParams ¶
func CreateSheetParams(title, description, thumbnail, id string, rows, columns, rank int) SheetParams
type SheetParamsEx ¶
type SheetParamsEx struct { Title string `json:"title,omitempty"` Description string `json:"description,omitempty"` Info *Info `json:"qInfo,omitempty"` ChildListDef *ChildListDef `json:"qChildListDef,omitempty"` }
func CreateSheetParamsEx ¶
func CreateSheetParamsEx(title, description, id string) SheetParamsEx
type StaticContentUrlDef ¶
type StaticContentUrlDef struct {
Url string `json:"qUrl,omitempty"`
}
type Stream ¶
type Stream struct { Name string `json:"name,omitempty"` Id string `json:"id,omitempty"` Privileges *Privileges `json:"privileges,omitempty"` }
type Thumbnail ¶
type Thumbnail struct {
StaticContentUrlDef *StaticContentUrlDef `json:"qStaticContentUrlDef,omitempty"`
}
func NewThumbnail ¶
type WebsocketError ¶
type WebsocketError struct { Code int `json:"code,omitempty"` Parameter string `json:"parameter,omitempty"` Message string `json:"message,omitempty"` }
func (*WebsocketError) GetError ¶
func (e *WebsocketError) GetError() error
Click to show internal directories.
Click to hide internal directories.