(P) client¶
(M) PeekClientPlatformHookABC¶
-
class
peek_plugin_base.client.PeekClientPlatformHookABC.
PeekClientPlatformHookABC
[source]¶ Bases:
peek_plugin_base.PeekPlatformCommonHookABC.PeekPlatformCommonHookABC
,peek_plugin_base.client.PeekPlatformFieldHttpHookABC.PeekPlatformFieldHttpHookABC
,peek_plugin_base.client.PeekPlatformOfficeHttpHookABC.PeekPlatformOfficeHttpHookABC
,peek_plugin_base.PeekPlatformServerInfoHookABC.PeekPlatformServerInfoHookABC
,peek_plugin_base.PeekPlatformFileStorageHookABC.PeekPlatformFileStorageHookABC
(M) PeekPlatformFieldHttpHookABC¶
-
class
peek_plugin_base.client.PeekPlatformFieldHttpHookABC.
PeekPlatformFieldHttpHookABC
[source]¶ Bases:
object
Peek Platform Site HTTP Hook
The methods provided by this class apply to the HTTP sites served by the Client service for the mobile and desktop apps, and the Server service for the admin app.
It is not the HTTP service that provides resources (vortex, etc) beween the server and the agent, worker and client.
-
addFieldResource
(pluginSubPath: bytes, resource: txhttputil.site.BasicResource.BasicResource) → None[source]¶ Add Site Resource
Add a cusotom implementation of a served http resource.
Parameters: - pluginSubPath – The resource path where you want to serve this resource.
- resource – The resource to serve.
Returns: None
-
addFieldStaticResourceDir
(dir: str) → None[source]¶ Add Site Static Resource Directory
Calling this method sets up directory
dir
to be served by the site.Parameters: dir – The file system directory to be served. Returns: None
-
rootFieldResource
¶ Site Root Resource
This returns the root site resource for this plugin.
-
(M) PeekPlatformOfficeHttpHookABC¶
-
class
peek_plugin_base.client.PeekPlatformOfficeHttpHookABC.
PeekPlatformOfficeHttpHookABC
[source]¶ Bases:
object
Peek Platform Site HTTP Hook
The methods provided by this class apply to the HTTP sites served by the Client service for the mobile and desktop apps, and the Server service for the admin app.
It is not the HTTP service that provides resources (vortex, etc) beween the server and the agent, worker and client.
-
addOfficeResource
(pluginSubPath: bytes, resource: txhttputil.site.BasicResource.BasicResource) → None[source]¶ Add Site Resource
Add a cusotom implementation of a served http resource.
Parameters: - pluginSubPath – The resource path where you want to serve this resource.
- resource – The resource to serve.
Returns: None
-
addOfficeStaticResourceDir
(dir: str) → None[source]¶ Add Site Static Resource Directory
Calling this method sets up directory
dir
to be served by the site.Parameters: dir – The file system directory to be served. Returns: None
-
rootOfficeResource
¶ Site Root Resource
This returns the root site resource for this plugin.
-
(M) PluginClientEntryHookABC¶
-
class
peek_plugin_base.client.PluginClientEntryHookABC.
PluginClientEntryHookABC
(pluginName: str, pluginRootDir: str, platform: peek_plugin_base.client.PeekClientPlatformHookABC.PeekClientPlatformHookABC)[source]¶ Bases:
peek_plugin_base.PluginCommonEntryHookABC.PluginCommonEntryHookABC
-
angularFrontendAppDir
¶ Angular Frontend Dir
This directory will be linked into the angular app when it is compiled.
Returns: The absolute path of the Angular2 app directory.
-
angularMainModule
¶ Angular Main Module
Returns: The name of the main module that the Angular2 router will lazy load.
-
platform
¶
-
publishedClientApi
¶
-