Documentation
¶
Index ¶
- type DocRequest
- type Event
- type FileDownloadRequest
- type FileReceiveRequest
- type FileRequest
- type FileSystemRequest
- type KVRequest
- type PodReceiveRequest
- type PodRequest
- type PodShareRequest
- type RenameRequest
- type UserLoginRequest
- type UserSignatureLoginRequest
- type UserSignupRequest
- type WebsocketRequest
- type WebsocketResponse
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type DocRequest ¶
type DocRequest struct {
PodName string `json:"podName,omitempty"`
TableName string `json:"tableName,omitempty"`
ID string `json:"id,omitempty"`
Document string `json:"doc,omitempty"`
SimpleIndex string `json:"si,omitempty"`
CompoundIndex string `json:"ci,omitempty"`
Expression string `json:"expr,omitempty"`
Mutable bool `json:"mutable,omitempty"`
Limit string `json:"limit,omitempty"`
FileName string `json:"fileName,omitempty"`
}
DocRequest is the request body for document operations
type Event ¶ added in v0.7.1
type Event string
Event is a string that represents a websocket event
var ( // UserSignup is the event for user signup UserSignup Event = "/user/signup" // UserLogin is the event for user login UserLogin Event = "/user/login" // UserIsLoggedin is the event for checking if a user is logged in UserIsLoggedin Event = "/user/isloggedin" // UserLogout is the event for user logout UserLogout Event = "/user/logout" // UserDelete is the event for user delete UserDelete Event = "/user/delete" // UserPresent is the event for checking if a user is present UserPresent Event = "/user/present" // UserStat is the event for user stat UserStat Event = "/user/stat" // PodNew is the event for pod new PodNew Event = "/pod/new" // PodOpen is the event for pod open PodOpen Event = "/pod/open" // PodClose is the event for pod close PodClose Event = "/pod/close" // PodSync is the event for pod sync PodSync Event = "/pod/sync" // PodDelete is the event for pod delete PodDelete Event = "/pod/delete" // PodLs is the event for listing all the pods PodLs Event = "/pod/ls" // PodStat is the event for pod stat PodStat Event = "/pod/stat" PodShare Event = "/pod/share" // PodReceive is the event for pod receive with sharingReference PodReceive Event = "/pod/receive" // PodReceiveInfo is the event for receive info of a pod from sharingReference PodReceiveInfo Event = "/pod/receiveinfo" // DirIsPresent is the event for checking if a directory is present DirIsPresent Event = "/dir/present" // DirMkdir is the event for making a directory DirMkdir Event = "/dir/mkdir" // DirRename is the event for renaming a directory DirRename Event = "/dir/rename" // DirRmdir is the event for removing a directory DirRmdir Event = "/dir/rmdir" // DirLs is the event for listing content in the directory DirLs Event = "/dir/ls" // DirStat is the event for directory stat DirStat Event = "/dir/stat" // FileDownload is the event for downloading a file FileDownload Event = "/file/download" // FileDownloadStream is the event for downloading a file stream FileDownloadStream Event = "/file/download/stream" // FileUpload is the event for uploading a file FileUpload Event = "/file/upload" // FileUploadStream is the event for uploading a file stream FileUploadStream Event = "/file/upload/stream" FileShare Event = "/file/share" // FileReceive is the event for receiving a file from sharingReference FileReceive Event = "/file/receive" // FileRename is the event for renaming a file FileRename Event = "/file/rename" // FileReceiveInfo is the event for receive info of a file from sharingReference FileReceiveInfo Event = "/file/receiveinfo" // FileDelete is the event for deleting a file FileDelete Event = "/file/delete" // FileStat is the event for file stat FileStat Event = "/file/stat" // KVCreate is the event for creating a KV store KVCreate Event = "/kv/new" // KVList is the event for listing all the KV stores KVList Event = "/kv/ls" // KVOpen is the event for opening a KV store KVOpen Event = "/kv/open" // KVDelete is the event for deleting a KV store KVDelete Event = "/kv/delete" // KVCount is the event for counting the number of entries in a KV store KVCount Event = "/kv/count" // KVEntryPresent is the event for checking if an entry is present in a KV store KVEntryPresent Event = "/kv/entry/present" // KVEntryPut is the event for putting an entry in a KV store KVEntryPut Event = "/kv/entry/put" // KVEntryGet is the event for getting an entry from a KV store KVEntryGet Event = "/kv/entry/get" // KVEntryDelete is the event for deleting an entry from a KV store KVEntryDelete Event = "/kv/entry/del" // KVLoadCSV is the event for loading a CSV file into a KV store KVLoadCSV Event = "/kv/loadcsv" // KVLoadCSVStream is the event for loading a CSV file into a KV store KVLoadCSVStream Event = "/kv/loadcsv/stream" // KVSeek is the event for seeking to a key in a KV store KVSeek Event = "/kv/seek" // KVSeekNext is the event for seeking to the next key in a KV store KVSeekNext Event = "/kv/seek/next" // DocCreate is the event for creating a document store DocCreate Event = "/doc/new" // DocList is the event for listing all the document stores DocList Event = "/doc/ls" // DocOpen is the event for opening a document store DocOpen Event = "/doc/open" // DocCount is the event for counting the number of documents in a document store DocCount Event = "/doc/count" // DocDelete is the event for deleting a document store DocDelete Event = "/doc/delete" // DocFind is the event for finding documents in a document store DocFind Event = "/doc/find" // DocEntryPut is the event for putting a document in a document store DocEntryPut Event = "/doc/entry/put" // DocEntryGet is the event for getting a document from a document store DocEntryGet Event = "/doc/entry/get" // DocEntryDel is the event for deleting a document from a document store DocEntryDel Event = "/doc/entry/del" // DocLoadJson is the event for loading a JSON file into a document store DocLoadJson Event = "/doc/loadjson" // DocLoadJsonStream is the event for loading a JSON file into a document store DocLoadJsonStream Event = "/doc/loadjson/stream" // DocIndexJson is the event for indexing a JSON file already in the pod into a document store DocIndexJson Event = "/doc/indexjson" )
type FileDownloadRequest ¶ added in v0.7.1
type FileDownloadRequest struct {
PodName string `json:"podName,omitempty"`
Filepath string `json:"filePath,omitempty"`
}
FileDownloadRequest is the request for file download
type FileReceiveRequest ¶ added in v0.9.1
type FileReceiveRequest struct {
PodName string `json:"podName,omitempty"`
SharingReference string `json:"sharingRef,omitempty"`
DirectoryPath string `json:"dirPath,omitempty"`
}
FileReceiveRequest is the request body for file receiving
type FileRequest ¶ added in v0.7.1
type FileRequest struct {
PodName string `json:"podName,omitempty"`
TableName string `json:"tableName,omitempty"`
DirPath string `json:"dirPath,omitempty"`
BlockSize string `json:"blockSize,omitempty"`
FileName string `json:"fileName,omitempty"`
ContentLength string `json:"contentLength,omitempty"`
Compression string `json:"compression,omitempty"`
Overwrite bool `json:"overwrite,omitempty"`
}
FileRequest is the request for file operations
type FileSystemRequest ¶
type FileSystemRequest struct {
PodName string `json:"podName,omitempty"`
GroupName string `json:"groupName,omitempty"`
DirectoryPath string `json:"dirPath,omitempty"`
DirectoryName string `json:"dirName,omitempty"`
FilePath string `json:"filePath,omitempty"`
FileName string `json:"fileName,omitempty"`
Destination string `json:"destUser,omitempty"`
}
FileSystemRequest is the request body for file system operations
type KVRequest ¶
type KVRequest struct {
PodName string `json:"podName,omitempty"`
TableName string `json:"tableName,omitempty"`
IndexType string `json:"indexType,omitempty"`
Key string `json:"key,omitempty"`
Value string `json:"value,omitempty"`
StartPrefix string `json:"startPrefix,omitempty"`
EndPrefix string `json:"endPrefix,omitempty"`
Limit string `json:"limit,omitempty"`
Memory string `json:"memory,omitempty"`
}
KVRequest is the request body for kv operations
type PodReceiveRequest ¶ added in v0.9.1
type PodReceiveRequest struct {
PodName string `json:"podName,omitempty"`
Reference string `json:"sharingRef,omitempty"`
}
PodReceiveRequest is the request body for pod receiving
type PodRequest ¶
type PodRequest struct {
PodName string `json:"podName,omitempty"`
Password string `json:"password,omitempty"`
Reference string `json:"reference,omitempty"`
}
PodRequest is the request body for pod creation
type PodShareRequest ¶ added in v0.9.1
type PodShareRequest struct {
}
PodShareRequest is the request body for pod sharing
type RenameRequest ¶ added in v0.9.1
type RenameRequest struct {
PodName string `json:"podName,omitempty"`
GroupName string `json:"groupName,omitempty"`
OldPath string `json:"oldPath,omitempty"`
NewPath string `json:"newPath,omitempty"`
}
RenameRequest is the request body for file rename
type UserLoginRequest ¶ added in v0.9.1
type UserLoginRequest struct {
UserName string `json:"userName,omitempty"`
Password string `json:"password,omitempty"`
}
UserLoginRequest is the request body for user login
type UserSignatureLoginRequest ¶ added in v0.10.1
type UserSignatureLoginRequest struct {
Signature string `json:"signature,omitempty"`
Password string `json:"password,omitempty"`
}
UserSignatureLoginRequest is the request body for user login with signature
type UserSignupRequest ¶ added in v0.9.1
type UserSignupRequest struct {
UserName string `json:"userName,omitempty"`
Password string `json:"password,omitempty"`
Mnemonic string `json:"mnemonic,omitempty"`
}
UserSignupRequest is the request body for user signup
type WebsocketRequest ¶ added in v0.7.1
type WebsocketRequest struct {
Id string `json:"_id"`
Event Event `json:"event"`
Params interface{} `json:"params,omitempty"`
}
WebsocketRequest is the request sent to the websocket
type WebsocketResponse ¶ added in v0.7.1
type WebsocketResponse struct {
Id string `json:"_id"`
Event Event `json:"event"`
Params interface{} `json:"params,omitempty"`
StatusCode int `json:"code,omitempty"`
// contains filtered or unexported fields
}
WebsocketResponse is the response sent from the websocket
func NewWebsocketResponse ¶ added in v0.7.1
func NewWebsocketResponse() *WebsocketResponse
NewWebsocketResponse creates a new WebsocketResponse
func (*WebsocketResponse) Marshal ¶ added in v0.7.1
func (w *WebsocketResponse) Marshal() []byte
Marshal marshals the response