github/Spaces-API
1
0
Fork 0
mirror of https://github.com/SociallyDev/Spaces-API.git synced 2025-08-19 04:50:08 -07:00
Code Issues Projects Releases Packages Wiki Activity Actions

Update README.md

Browse source
This commit is contained in:
Devang Srivastava 2017-12-07 22:00:11 +05:30 • committed by GitHub
commit 07c1762818
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 36 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

38
README.md
View file

@ -10,9 +10,43 @@ require_once("spaces.php");
$key = "EXAMPLE_KEY"; $key = "EXAMPLE_KEY";
$secret = "EXAMPLE_SECRET"; $secret = "EXAMPLE_SECRET";
$space = new SpacesConnect($key, $secret); $space = "my-space";
$space = new SpacesConnect($key, $secret, $space);
``` ```
All available configurations: All available options:
###### SpacesConnect( REQUIRED KEY, REQUIRED SECRET, OPTIONAL SPACE's NAME, OPTIONAL REGION, OPTION HOST DOMAIN ); ###### SpacesConnect( REQUIRED KEY, REQUIRED SECRET, OPTIONAL SPACE's NAME, OPTIONAL REGION, OPTION HOST DOMAIN );
<br />
### Uploading/Downloading Files
```php
$path_to_file = "folder/my-image.png";
$optional_file_name = "image.png";
$space->uploadFile($path_to_file, $optional_file_name);
```
All available options:
###### uploadFile( REQUIRED PATH TO FILE, OPTIONAL NAME TO SAVE FILE AS);
<br />
### Creating Temporary Links
```php
$file = "image.png";
$valid_for = "1 day";
$link = $space->CreateTemporaryURL($file, $valid_for);
```
All available options:
###### CreateTemporaryURL( REQUIRED FILE NAME, OPTIONAL TIME LINK IS VALID FOR);
<br />
### Creating Spaces
```php
$new_space = "my-new-space";
$space->createSpace($new_space);
```
All available options:
###### createSpace( REQUIRED SPACE NAME, OPTIONAL REGION FOR SPACE);