PlayReadySecureStopServiceRequest
PlayReadySecureStopServiceRequest
PlayReadySecureStopServiceRequest
PlayReadySecureStopServiceRequest
Class
Definition
Manages secure stop messages.
public : sealed class PlayReadySecureStopServiceRequest : IMediaProtectionServiceRequest, IPlayReadySecureStopServiceRequest, IPlayReadyServiceRequestpublic sealed class PlayReadySecureStopServiceRequest : IMediaProtectionServiceRequest, IPlayReadySecureStopServiceRequest, IPlayReadyServiceRequestPublic NotInheritable Class PlayReadySecureStopServiceRequest Implements IMediaProtectionServiceRequest, IPlayReadySecureStopServiceRequest, IPlayReadyServiceRequest// You can use this class in JavaScript.
- Attributes
| Device family |
Windows 10 (introduced v10.0.10240.0)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduced v1)
|
Constructors
PlayReadySecureStopServiceRequest(Byte[]) PlayReadySecureStopServiceRequest(Byte[]) PlayReadySecureStopServiceRequest(Byte[]) PlayReadySecureStopServiceRequest(Byte[])
Initializes a new instance of the PlayReadySecureStopServiceRequest class to include all secure stop sessions.
public : PlayReadySecureStopServiceRequest(Byte[] publisherCertBytes)public PlayReadySecureStopServiceRequest(Byte[] publisherCertBytes)Public Sub New(publisherCertBytes As Byte[])// You can use this method in JavaScript.
- publisherCertBytes
- Byte[] Byte[] Byte[] Byte[]
The raw binary body of the publisher certificate.
- See Also
PlayReadySecureStopServiceRequest(Guid, Byte[]) PlayReadySecureStopServiceRequest(Guid, Byte[]) PlayReadySecureStopServiceRequest(Guid, Byte[]) PlayReadySecureStopServiceRequest(Guid, Byte[])
Initializes a new instance of the PlayReadySecureStopServiceRequest class for the specified secure stop session.
public : PlayReadySecureStopServiceRequest(PlatForm::Guid sessionID, Byte[] publisherCertBytes)public PlayReadySecureStopServiceRequest(Guid sessionID, Byte[] publisherCertBytes)Public Sub New(sessionID As Guid, publisherCertBytes As Byte[])// You can use this method in JavaScript.
- sessionID
- PlatForm::Guid Guid Guid Guid
The secure stop session identifier.
- publisherCertBytes
- Byte[] Byte[] Byte[] Byte[]
The raw binary body of the publisher certificate.
- See Also
Properties
ChallengeCustomData ChallengeCustomData ChallengeCustomData ChallengeCustomData
Gets or sets the custom data of the request challenge.
public : PlatForm::String ChallengeCustomData { get; set; }public string ChallengeCustomData { get; set; }Public ReadWrite Property ChallengeCustomData As string// You can use this property in JavaScript.
- Value
- PlatForm::String string string string
The custom data.
Remarks
Use this property to get the custom data to be placed in the request challenge or to set the challenge custom data to send up as part of the request.
Setting this property is optional.
This property cannot be set after BeginServiceRequest or GenerateManualEnablingChallenge have been called.
ProtectionSystem ProtectionSystem ProtectionSystem ProtectionSystem
Gets the vendor content protection system identifier.
public : PlatForm::Guid ProtectionSystem { get; }public Guid ProtectionSystem { get; }Public ReadOnly Property ProtectionSystem As Guid// You can use this property in JavaScript.
- Value
- PlatForm::Guid Guid Guid Guid
The vendor content protection system identifier. This property value is sensitive to the underlying platform's endianness. Carefully test your app on all platforms you intend to support to ensure that correct endianness is used on each platform.
Remarks
This property allows the app to identify the content protection system being used and therefore how to interpret the protection task.
PublisherCertificate PublisherCertificate PublisherCertificate PublisherCertificate
Gets the current publisher certificate property.
public : byte[] PublisherCertificate { get; }public byte[] PublisherCertificate { get; }Public ReadOnly Property PublisherCertificate As byte[]// You can use this property in JavaScript.
- Value
- byte[] byte[] byte[] byte[]
The raw binary body of the publisher certificate.
ResponseCustomData ResponseCustomData ResponseCustomData ResponseCustomData
Gets the custom data that was returned in the response from the service.
public : PlatForm::String ResponseCustomData { get; }public string ResponseCustomData { get; }Public ReadOnly Property ResponseCustomData As string// You can use this property in JavaScript.
- Value
- PlatForm::String string string string
The custom data.
Remarks
This property can be called only after the service request has been completed.
SessionID SessionID SessionID SessionID
Gets the session identifier property.
public : PlatForm::Guid SessionID { get; }public Guid SessionID { get; }Public ReadOnly Property SessionID As Guid// You can use this property in JavaScript.
- Value
- PlatForm::Guid Guid Guid Guid
Gets the session identifier property.
StartTime StartTime StartTime StartTime
Gets the secure stop session's start time property.
public : DateTime StartTime { get; }public DateTimeOffset StartTime { get; }Public ReadOnly Property StartTime As DateTimeOffset// You can use this property in JavaScript.
- Value
- DateTime DateTimeOffset DateTimeOffset DateTimeOffset
The secure stop session's start time.
Stopped Stopped Stopped Stopped
Gets the secure stop session's stopped flag property which indicates whether the secure stop session for this request was cleanly shut down.
public : PlatForm::Boolean Stopped { get; }public bool Stopped { get; }Public ReadOnly Property Stopped As bool// You can use this property in JavaScript.
- Value
- PlatForm::Boolean bool bool bool
The secure stop session's stopped flag.
Type Type Type Type
Gets the GUID for the type of operation that the PlayReady secure stop service request performs.
public : PlatForm::Guid Type { get; }public Guid Type { get; }Public ReadOnly Property Type As Guid// You can use this property in JavaScript.
- Value
- PlatForm::Guid Guid Guid Guid
The GUID for the type of operation. This property value is sensitive to the underlying platform's endianness. Carefully test your app on all platforms you intend to support to ensure that correct endianness is used on each platform.
Remarks
The possible values of Type depend on the content protection system used for the content. This can be determined by context or by inspecting the ProtectionSystem property.
UpdateTime UpdateTime UpdateTime UpdateTime
Gets the secure stop session's update/stop time property.
public : DateTime UpdateTime { get; }public DateTimeOffset UpdateTime { get; }Public ReadOnly Property UpdateTime As DateTimeOffset// You can use this property in JavaScript.
- Value
- DateTime DateTimeOffset DateTimeOffset DateTimeOffset
The secure stop session's update/stop time.
Uri Uri Uri Uri
Gets or sets the URI used to perform a service request action.
public : Uri Uri { get; set; }public Uri Uri { get; set; }Public ReadWrite Property Uri As Uri// You can use this property in JavaScript.
- Value
- Uri Uri Uri Uri
The URI to be used.
Remarks
The URI must be set through this property before calling BeginServiceRequest.
This property cannot be set after BeginServiceRequest or GenerateManualEnablingChallenge have been called.
Methods
BeginServiceRequest() BeginServiceRequest() BeginServiceRequest() BeginServiceRequest()
Begins an asynchronous service request operation.
public : IAsyncAction BeginServiceRequest()public IAsyncAction BeginServiceRequest()Public Function BeginServiceRequest() As IAsyncAction// You can use this method in JavaScript.
The asynchronous service action.
Remarks
Completion and results can be retrieved using the IAsyncAction interface that is returned. Calling this method places the class in a read-only state.
GenerateManualEnablingChallenge() GenerateManualEnablingChallenge() GenerateManualEnablingChallenge() GenerateManualEnablingChallenge()
Begins the process of manually enabling.
public : PlayReadySoapMessage GenerateManualEnablingChallenge()public PlayReadySoapMessage GenerateManualEnablingChallenge()Public Function GenerateManualEnablingChallenge() As PlayReadySoapMessage// You can use this method in JavaScript.
The SOAP message to be used in a manual license acquisition challenge request.
Remarks
Provides the caller the raw HTTP challenge and headers that they must send up to the server. When the response is received, it should be processed by calling the ProcessManualEnablingResponse method.
NextServiceRequest() NextServiceRequest() NextServiceRequest() NextServiceRequest()
Returns a new service request interface.
public : IPlayReadyServiceRequest NextServiceRequest()public IPlayReadyServiceRequest NextServiceRequest()Public Function NextServiceRequest() As IPlayReadyServiceRequest// You can use this method in JavaScript.
The new service request interface.
Remarks
This method should only be called after:
- A completion event from the IAsyncAction object returned from BeginServiceRequest has indicated the current service request is complete (automatic enabling).
- A call to ProcessManualEnablingResponse (manual enabling).
Both of the above situations leave the current service request in a read-only/complete state, although there could be additional service requests to perform. An app should call this method to determine if additional service requests are required.
ProcessManualEnablingResponse(Byte[]) ProcessManualEnablingResponse(Byte[]) ProcessManualEnablingResponse(Byte[]) ProcessManualEnablingResponse(Byte[])
Process the raw binary result of a manual enabling challenge.
public : HResult ProcessManualEnablingResponse(Byte[] responseBytes)public Exception ProcessManualEnablingResponse(Byte[] responseBytes)Public Function ProcessManualEnablingResponse(responseBytes As Byte[]) As Exception// You can use this method in JavaScript.
- responseBytes
- Byte[] Byte[] Byte[] Byte[]
The response result to be processed.
If the methods succeeds, it returns S_OK. If it fails, it returns an error code.
Remarks
The return value of this method is a failure only if the input data is invalid in some way. If the result is processed successfully but has a failure state, this method will return that failure in the result parameter.
The most common values to be returned in the result parameter are:
- S_OK—The enabling response was processed and there are no more service requests necessary. A following call to NextServiceRequest will return a NULL pointer.
- MSPR_E_CONTENT_ENABLING_ACTION_REQUIRED—A new service request was generated when processing the current service request. A call to NextServiceRequest should be made.
- DRM_E_SERVER_SERVICE_SPECIFIC—A PlayReady license or domain server failed.
- MSPR_E_SDK_UPDATE_REQUIRED—The individualization service requires a client SDK update before a new individualization operation can complete. Refreshing the PlayReady SDK is required.