Difference between revisions of "Service"

From Gvp-public
Jump to navigation Jump to search
 
(5 intermediate revisions by the same user not shown)
Line 60: Line 60:
 
Text that will be shown in the agreement pop-up of the service
 
Text that will be shown in the agreement pop-up of the service
 
{{!}}- valign="top"
 
{{!}}- valign="top"
 +
 +
! AgreementAccepted
 +
{{!}} string
 +
{{!}} bgcolor="#7DC04E" {{!}} '''NEW IN 4.1!'''
 +
Only for GetUserServices Response, indicates if the user Has Accepted the user agreement
 +
{{!}}- valign="top"
 +
  
 
{{!}}}
 
{{!}}}
Line 73: Line 80:
 
         "ServiceTypeName": "Global service",
 
         "ServiceTypeName": "Global service",
 
         "InstanceId": 14,
 
         "InstanceId": 14,
         "ResizableImages": [Array of Images]
+
         "ResizableImages": [Array of Images],
 +
        "RequiresUserAgreement": true,
 +
        "UserAgreementText": "This Service grant access to nPVR recordings service, do you agree to keep network recorded copies of your contents?"
 
}
 
}
 
</syntaxhighlight >
 
</syntaxhighlight >
 +
 +
|KnownIssues=
 +
[[ServicesUsage|Hot to Use Services]]
  
  
|KnownIssues=
 
None
 
 
|VersionHistory=
 
|VersionHistory=
 
{{{!}} border="2" style="width:800px;" cellpadding="5" cellspacing="0"  
 
{{{!}} border="2" style="width:800px;" cellpadding="5" cellspacing="0"  
Line 90: Line 100:
 
{{!}} New object. Initial design.
 
{{!}} New object. Initial design.
 
{{!}} Jose A. Jimenez
 
{{!}} Jose A. Jimenez
 +
{{!}}- valign="top"
 +
! 4.1
 +
{{!}} Agreements.
 +
{{!}} José Manuel Escartín
 
{{!}}}
 
{{!}}}
  

Latest revision as of 15:33, 28 November 2017

Represents a Service object. Services provide access to an specific feature such as nPVR, RestartTV (Timeshift), etc. Services are not purchased standalone, they are always commercialized inside Subscriptions.

Members

Field Data Type Description
ID int Unique identifier for the Service
Name String The name for the Service
Description String A long description of the Service that will be shown to end users.
ServiceTypeId int The value for the ServiceType enum that indicates the type of service.
ServiceTypeName String The name for the Service Type
InstanceId int InstanceId
ResizableImages Array of Image object NEW IN 2.3!

It provides the list of original images (non resized) associated with this Subscription. The application should use the Thumbox Service to perform dynamic resizing of the images in order to adapt them to the User Interface.

RequiresUserAgreement boolean NEW IN 4.1!

Indicates if the service needs to be accepted by the user before enjoy it

UserAgreementText string NEW IN 4.1!

Text that will be shown in the agreement pop-up of the service

AgreementAccepted string NEW IN 4.1!

Only for GetUserServices Response, indicates if the user Has Accepted the user agreement


Example

{
        "ID": 51,
        "Name": "nPVR Service",
        "Description": "Description for nPVR Service",
        "ServiceTypeId": 1,
        "ServiceTypeName": "Global service",
        "InstanceId": 14,
        "ResizableImages": [Array of Images],
        "RequiresUserAgreement": true,
        "UserAgreementText": "This Service grant access to nPVR recordings service, do you agree to keep network recorded copies of your contents?"
}


Known issues

Hot to Use Services


Version history

API Version Number Change description Changes author
2.4 New object. Initial design. Jose A. Jimenez
4.1 Agreements. José Manuel Escartín


See also