CNetUbiServicesNews Struct Reference

#include <doc.h>

Inheritance diagram for CNetUbiServicesNews:

Public Member Functions
Integer	GetPublicationDate (Integer Month, Integer Day, Integer Hour, Integer Minute, Integer Second)
Void	GetLinkInfo (Integer LinkIndex, Text Type, Text Param, Text ActionName, Text ActionDescription)

Public Attributes
const Ident	Id
const Text	NewsId
const Text	Type
const Text	Placement
const Text	Locale
const Text	Title
const Text	Body
const Text	MediaUrl
const Text	MediaType
const Integer	Priority
const Integer	DisplayTime
const Integer	LinksCount
Public Attributes inherited from CNod
const Ident	Id

Detailed Description

UbiServices news.

Member Function Documentation

GetLinkInfo()

Void CNetUbiServicesNews::GetLinkInfo	(	Integer	LinkIndex,
		Text	Type,
		Text	Param,
		Text	ActionName,
		Text	ActionDescription )

Returns Type, Param, ActionName and ActionDescription of the link. Type allows the game to correctly interpret param. The value may be game-specific but there are the following predefined types: "pstore" means that the param field contains the DLC ID related to the news content, "sstore" means that the param field contains an Offer ID related to an offer being available on the secondary store. "weblink" means that the param field should be an URL to a web page. Param defines the parameter value of the action. For a "pstore" type, value must be the DLC ID of the 1st party store (platform specific). For example, PS3 would look like "UP0001-NPUB90687_00-ACEMBERSVIDEO001", while on Xbox, it would look like: "0x555308796ea1e800". For a "sstore" type, value must be an Offer ID of the secondary store. This depends on the Secondary Store implementation of the game. For a "weblink" type, value must be a valid HTTP address. ActionName is The name of the action for tracking purposes. ActionDescription is the description of the action the game should display. The game must support default descriptions such as "Buy" for a store link.

GetPublicationDate()

Integer CNetUbiServicesNews::GetPublicationDate	(	Integer	Month,
		Integer	Day,
		Integer	Hour,
		Integer	Minute,
		Integer	Second )

Returns the date and (UTC) time at which the news was published.

Member Data Documentation

Body

const Text CNetUbiServicesNews::Body

Localized body of the news

DisplayTime

const Integer CNetUbiServicesNews::DisplayTime

The minimum time in seconds at which this news item should be displayed.

LinksCount

const Integer CNetUbiServicesNews::LinksCount

The number of links attached to this news. Links are mandatory for given types. For example, DLCOffer should have a mandatory storelink type link.

Locale

const Text CNetUbiServicesNews::Locale

Localization string of the news, e.g. "en-US"

MediaType

const Text CNetUbiServicesNews::MediaType

MIME type of the media object to display. e.g. "image/png" or "video/mp4"

MediaUrl

const Text CNetUbiServicesNews::MediaUrl

Link to an image or video to be displayed with the news. Format of the media is placement specific.

NewsId

const Text CNetUbiServicesNews::NewsId

A globally unique ID for the news item.

Placement

const Text CNetUbiServicesNews::Placement

Specifies where the news should be placed in-game.

Priority

const Integer CNetUbiServicesNews::Priority

The priority that should be given to that news.

Title

const Text CNetUbiServicesNews::Title

Localized title of the news

Type

const Text CNetUbiServicesNews::Type

There is no predefined value, it is a contract between the producer and the consumer to define game specific.

---

The documentation for this struct was generated from the following file:

• doc.h