News.Headlines.Definition
Summary
This method is responsible for retrieving News.Headlines data.
Methods
Definition(query: srting)
Allows you to create a short definition for the News contect object
Parameter:
| Name | Is Optional | Default Value | Type | Description |
|---|---|---|---|---|
| query | No | - | string | The search query |
Returned value: a Definition object
Definition(params: News.Headlines.Param)
Allows you to create a full definition for the News contect object
News.Headlines.Params properties :
| Property | Is Optional | Default Value | Type | Description |
|---|---|---|---|---|
| query | No | - | string | The search query |
| count | Yes | 10 | number | The number of headlines. Values range: 1-100 |
| dateFrom | Yes | - | string | Date range (ex: 2014-01-01T10:00:00.000Z) |
| dateTo | Yes | - | string | Date range (ex: 2014-01-01T10:00:00.000Z) |
| relevance | Yes | - | enum | Defines the relevancy of the headline. See Relevancy |
| sort | Yes | News.Headlines.SortDirection.NewToOld | enum | Defines the sorting order. See SortDirection |
| extendedParams | Yes | - | {[key: string]: any} | Specifies the parameters that will be merged with the request |
Returned value: a Definition object
getData(session: Session)
Sends a request to the data platform to retrieve conversion results described by the Definition object.
Parameter:
| Name | Is Optional | Default Value | Type | Description |
|---|---|---|---|---|
| session | No | - | Session | Session instance |
Returned value: a ContentResponse
Example of usage:
const definition = News.Headlines.Definition({ query: 'Refinitiv', sort: News.Headlines.SortDirection.OldToNew });
const headlines = await definition.getData(containerSession);