API Documentation
Table of Contents
- seafile_MetaData() : mixed
- seafile_ConfigOptions() : array<string|int, mixed>
- Define SeaFile product configuration options.
- seafile_TestConnection() : array<string|int, mixed>
- Test connection to a SeaFile server with the given server parameters.
- seafile_UsageUpdate() : mixed
- Usage Update
- seafile_ClientArea() : array<string|int, mixed>
- Client area output logic handling.
- seafile_ChangePassword() : string
- Change the password for a SeaFile account.
- seafile_ChangePackage() : string
- Set a new quota of a SeaFile account.
- seafile_CreateAccount() : string
- Provision a new instance of a SeaFile account.
- seafile_SuspendAccount() : string
- Set a SeaFile account to status inactive.
- seafile_UnsuspendAccount() : string
- Set a SeaFile account to status active.
- seafile_TerminateAccount() : string
- Removes a SeaFile account.
- seafileCheckPassword() : string
- server side password check
Functions
seafile_MetaData()
seafile_MetaData() : mixed
seafile_ConfigOptions()
Define SeaFile product configuration options.
seafile_ConfigOptions() : array<string|int, mixed>
Tags
seafile_TestConnection()
Test connection to a SeaFile server with the given server parameters.
seafile_TestConnection(array<string|int, mixed> $params) : array<string|int, mixed>
Allows an admin user to verify that an API connection can be successfully made with the given configuration parameters for a server.
When defined in a module, a Test Connection button will appear alongside the Server Type dropdown when adding or editing an existing server.
Parameters
- $params : array<string|int, mixed>
-
common module parameters
Tags
seafile_UsageUpdate()
Usage Update
seafile_UsageUpdate(array<string|int, mixed> $params) : mixed
Important: Runs daily per server not per product Run Manually: /admin/reports.php?report=disk_usage_summary&action=updatestats
Parameters
- $params : array<string|int, mixed>
-
common module parameters
Tags
seafile_ClientArea()
Client area output logic handling.
seafile_ClientArea(array<string|int, mixed> $params) : array<string|int, mixed>
This function is used to define module specific client area output. It should return an array consisting of a template file and optional additional template variables to make available to that template.
The template file you return can be one of two types:
-
tabOverviewModuleOutputTemplate - The output of the template provided here will be displayed as part of the default product/service client area product overview page.
-
tabOverviewReplacementTemplate - Alternatively using this option allows you to entirely take control of the product/service overview page within the client area.
Whichever option you choose, extra template variables are defined in the same way. This demonstrates the use of the full replacement.
Please Note: Using tabOverviewReplacementTemplate means you should display the standard information such as pricing and billing details in your custom template or they will not be visible to the end user.
Parameters
- $params : array<string|int, mixed>
-
common module parameters
Tags
seafile_ChangePassword()
Change the password for a SeaFile account.
seafile_ChangePassword(array<string|int, mixed> $params) : string
Called when a password change is requested. This can occur either due to a client requesting it via the client area or an admin requesting it from the admin side.
This option is only available to client end users when the product is in an active status.
Parameters
- $params : array<string|int, mixed>
-
common module parameters
Tags
seafile_ChangePackage()
Set a new quota of a SeaFile account.
seafile_ChangePackage(array<string|int, mixed> $params) : string
Called to apply a quota change of the service. It is called to provision upgrade or downgrade orders, as well as being able to be invoked manually by an admin user.
This same function is called for upgrades and downgrades of both products and configurable options.
Parameters
- $params : array<string|int, mixed>
-
common module parameters
Tags
seafile_CreateAccount()
Provision a new instance of a SeaFile account.
seafile_CreateAccount(array<string|int, mixed> $params) : string
Attempt to provision a new SeaFile account. This is called any time provisioning is requested inside of WHMCS. Depending upon the configuration, this can be any of:
- When a new order is placed
- When an invoice for a new order is paid
- Upon manual request by an admin user
Parameters
- $params : array<string|int, mixed>
-
common module parameters
Tags
seafile_SuspendAccount()
Set a SeaFile account to status inactive.
seafile_SuspendAccount(array<string|int, mixed> $params) : string
Called when a suspension is requested. This is invoked automatically by WHMCS when a product becomes overdue on payment or can be called manually by admin user.
Parameters
- $params : array<string|int, mixed>
-
common module parameters
Tags
seafile_UnsuspendAccount()
Set a SeaFile account to status active.
seafile_UnsuspendAccount(array<string|int, mixed> $params) : string
Called when an un-suspension is requested. This is invoked automatically upon payment of an overdue invoice for a product, or can be called manually by admin user.
Parameters
- $params : array<string|int, mixed>
-
common module parameters
Tags
seafile_TerminateAccount()
Removes a SeaFile account.
seafile_TerminateAccount(array<string|int, mixed> $params) : string
Called when a termination is requested. This can be invoked automatically for overdue products if enabled, or requested manually by an admin user.
Parameters
- $params : array<string|int, mixed>
-
common module parameters
Tags
seafileCheckPassword()
server side password check
seafileCheckPassword(string $pwd) : string
recheck the client side password check in case that the client side check has been disabled
Parameters
- $pwd : string
-
password