Click or drag to resize

IInfrascaleSdkCancelOnlineBackup Method

Cancel the current backup session.

Namespace:  SOS.SDK.Contracts
Assembly:  SOS.SDK (in SOS.SDK.dll) Version: 7.6.1.5742
Syntax
C#
Copy
CancelOnlineBackupResponse CancelOnlineBackup(
	CancelOnlineBackupRequest request
)

Parameters

request
Type: SOS.SDK.Contracts.DataContracts.RequestsCancelOnlineBackupRequest
Parameters of the cancellation.

Return Value

Type: CancelOnlineBackupResponse
Cancellation results.
Exceptions
ExceptionCondition
NotSignedIn
MethodCallFailed
Remarks
Cancels the current backup session, regardless of who launched it. If there are other requests for backup in the queue, they will be executed immediately after the current session is canceled. In the absence of active sessions, the Cancel does nothing.
Examples
Example 1
Copy
using SOS.SDK.Contracts.DataContracts;
using SOS.SDK.Contracts.DataContracts.Requests;

namespace SOS.SDK.Test.Examples.OnlineBackup
{
    public class OnlineBackupStateExamples
    {
        private string _testAccount = @"sdk.test@sosonlinebackup.com";
        private string _testAccountPassword = @"qweqwe";
        private IInfrascaleClient _client;

        public IdentityContract SignIn()
        {
            _client = new InfrascaleClient();
            _client.Connect();

            var signInResponse = _client.SignIn(new SignInRequest
            {
                Credentials = new CredentialsContract {Login = _testAccount, Password = _testAccountPassword}
            });

            return signInResponse.Identity;
        }

        public void CancelOnlineBackup()
        {
            var identity = SignIn();
            _client.CancelOnlineBackup(new CancelOnlineBackupRequest {Identity = identity});
        }
    }
}
See Also