Set Protection Properties

Introduction

The following methods allow you to set protection properties for a PowerPoint presentation. You can set passwords to read/write the presentation, or set read-only recommendation.

SetProtection

API Information

API	Type	Description	Resource
/slides/{name}/protection	PUT	Sets the protection properties for a presentation saved to the storage.	SetProtection

Request Parameters

Name	Type	Location	Required	Description
name	string	path	true	The name of the presentation file.
dto	ProtectionProperties	body	true	The protection properties for the presentation.
password	string	header	false	The password to open the presentation.
folder	string	query	false	The path to the folder containing the presentation.
storage	string	query	false	The name of the storage contaning the `folder`.

In case of Amazon S3 storage folder path starts with Amazon S3 bucket name.

Examples

Specify the string MyPassword to protect the document MyPresentation.pptx to read and set the recommendation to read-only for the presentation.

cURL Solution

Request

Get an Access Token

curl -X POST "https://api.aspose.cloud/connect/token" \
     -d "grant_type=client_credentials&client_id=MyClientId&client_secret=MyClientSecret" \
     -H "Content-Type: application/x-www-form-urlencoded"

Set the Protection Properties

curl -X PUT "https://api.aspose.cloud/v3.0/slides/MyPresentation.pptx/protection" \
     -H "Authorization: Bearer MyAccessToken" \
     -H "accept: application/json" \
     -H "Content-Type: application/json" \
     -d @ProtectionProperties.json

ProtectionProperties.json content:

{
    "ReadPassword": "MyPassword",
    "ReadOnlyRecommended": true
}

Response

Response Example

{
    "encryptDocumentProperties": true,
    "readOnlyRecommended": true,
    "readPassword": "MyPassword",
    "isWriteProtected": false,
    "isEncrypted": true,
    "selfUri": {
        "href": "https://api.aspose.cloud/v3.0/slides/MyPresentation.pptx/protectionProperties",
        "relation": "self"
    }
}

SDK Solutions

using Aspose.Slides.Cloud.Sdk;
using Aspose.Slides.Cloud.Sdk.Model;

class Application
{
    static void Main(string[] args)
    {
        var slidesApi = new SlidesApi("MyClientId", "MyClientSecret");

        // Prepare the protection properties for the presentation.
        var properties = new ProtectionProperties
        {
            ReadPassword = "MyPassword",
            ReadOnlyRecommended = true
        };

        var response = slidesApi.SetProtection("MyPresentation.pptx", properties);

        // Check if the presentation has been encrypted.
        Console.WriteLine(response.IsEncrypted);
    }
}

Java

import com.aspose.slides.ApiException;
import com.aspose.slides.api.SlidesApi;
import com.aspose.slides.model.ProtectionProperties;

public class Application {
    public static void main(String[] args) throws ApiException {
        SlidesApi slidesApi = new SlidesApi("MyClientId", "MyClientSecret");

        // Prepare the protection properties for the presentation.
        ProtectionProperties properties = new ProtectionProperties();
        properties.setReadPassword("MyPassword");
        properties.setReadOnlyRecommended(true);

        ProtectionProperties response = slidesApi.setProtection("MyPresentation.pptx", properties, null, null, null);

        // Check if the presentation has been encrypted.
        System.out.println(response.getIsEncrypted());
    }
}

PHP

use Aspose\Slides\Cloud\Sdk\Api\Configuration;
use Aspose\Slides\Cloud\Sdk\Api\SlidesApi;
use Aspose\Slides\Cloud\Sdk\Model\ProtectionProperties;

$configuration = new Configuration();
$configuration->setAppSid("MyClientId");
$configuration->setAppKey("MyClientSecret");

$slidesApi = new SlidesApi(null, $configuration);

// Prepare the protection properties for the presentation.
$properties = new ProtectionProperties();
$properties->setReadPassword("MyPassword");
$properties->setReadOnlyRecommended(true);

$response = $slidesApi->setProtection("MyPresentation.pptx", $properties);

// Check if the presentation has been encrypted.
echo $response->getIsEncrypted();

Ruby

require "aspose_slides_cloud"

include AsposeSlidesCloud

configuration = Configuration.new
configuration.app_sid = "MyClientId"
configuration.app_key = "MyClientSecret"

slides_api = SlidesApi.new(configuration)

# Prepare the protection properties for the presentation.
properties = ProtectionProperties.new
properties.read_password = "MyPassword"
properties.read_only_recommended = true

response = slides_api.set_protection("MyPresentation.pptx", properties)

# Check if the presentation has been encrypted.
puts response.is_encrypted

Python

import asposeslidescloud

from asposeslidescloud.apis.slides_api import SlidesApi
from asposeslidescloud.models import ProtectionProperties

slides_api = SlidesApi(None, "MyClientId", "MyClientSecret")

# Prepare the protection properties for the presentation.
properties = ProtectionProperties()
properties.read_password = "MyPassword"
properties.read_only_recommended = True

response = slides_api.set_protection("MyPresentation.pptx", properties)

# Check if the presentation has been encrypted.
print(response.is_encrypted)

Node.js

const cloud = require("asposeslidescloud");

const slidesApi = new cloud.SlidesApi("MyClientId", "MyClientSecret");

// Prepare the protection properties for the presentation.
const properties = new cloud.ProtectionProperties();
properties.readPassword = "MyPassword";
properties.readOnlyRecommended = true;

slidesApi.setProtection("MyPresentation.pptx", properties).then(response => {
    // Check if the presentation has been encrypted.
    console.log(response.body.isIsEncrypted);
});

C++

Perl

use AsposeSlidesCloud::Configuration;
use AsposeSlidesCloud::SlidesApi;
use AsposeSlidesCloud::Object::ProtectionProperties;

my $config = AsposeSlidesCloud::Configuration->new();
$config->{app_sid} = "MyClientId";
$config->{app_key} = "MyClientSecret";

my $slides_api = AsposeSlidesCloud::SlidesApi->new(config => $config);

# Prepare protection properties for the presentation.
my $properties = AsposeSlidesCloud::Object::ProtectionProperties->new();
$properties->{read_password} = "MyPassword";
$properties->{read_only_recommended} = 1;

my %parameters = (name => "MyPresentation.pptx", dto => $properties);
my $response = $slides_api->set_protection(%parameters);

# Check if the presentation has been encrypted.
print($response->{is_encrypted});

Swift

SetProtectionOnline