SAP ABAP Interface IF_CLB2_FEED_GW (Feed Representation at Gateway (Notification))
Hierarchy
☛
SAP_UI (Software Component) User Interface Technology
⤷
CA-UI2-AR-SM (Application Component) SAP UI Integration - Social Media Collaboration Enablement
⤷
CLB2_NOTIFY (Package) Subscription and Notification Scenarios
SAP_UI (Software Component) User Interface Technology⤷
CA-UI2-AR-SM (Application Component) SAP UI Integration - Social Media Collaboration Enablement⤷
CLB2_NOTIFY (Package) Subscription and Notification Scenarios
Meta Relationship - Used By
| # | Relationship type | Used by | Short Description | Created on |
|---|---|---|---|---|
| 1 | Interface implementation (CLASS c. INTERFACES i_ref) | CL_CLB2_FEED_GW | Feed Representation at Gateway (Notification) | 20130516 |
Properties
| Interface | IF_CLB2_FEED_GW | |
| Short Description | Feed Representation at Gateway (Notification) |
General Data
| Package | CLB2_NOTIFY | Subscription and Notification Scenarios |
| Created | 20130516 | SAP |
| Last changed | 20141120 | |
| Unicode checks active |
Forward declarations
Interface IF_CLB2_FEED_GW has no forward declaration.
Interfaces
Interface IF_CLB2_FEED_GW has no interface.
Friends
Interface IF_CLB2_FEED_GW has no friend.
Attributes
| # | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | MS_NOTIFY_APP | Instance attribute | Public | Type reference (TYPE) | IF_CLB2_CUST_QUERIES=>TY_S_APPLI_PLATF | Application to be notified | 20130516 | ||
| 2 | RETRY_FLAG | Constant | Public | See coding | 20130516 | ||||
| 3 | VERB_TYPE | Constant | Public | See coding | 20130516 |
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | DISTRIBUTE_NOTIFICATIONS |
Instance method | Public | Method | Distribute GW Notifications to Applications | 20130516 |
| 2 | ERROR_HANDLING |
Instance method | Public | Method | Error Handling for (First) Distribution | 20130516 |
| 3 | ERROR_HANDLING_RETRY |
Instance method | Public | Method | Error Handling for Retry | 20130516 |
| 4 | POST_USER_FEED |
Instance method | Public | Method | Post User Feed from GW | 20130516 |
Events
Interface IF_CLB2_FEED_GW has no event.
Types
| # | Type | Visibility | Typing | Associated Type | Description | Created on | Type Source |
|---|---|---|---|---|---|---|---|
| 1 | TTY_NOTIF_REC_ID | Public | See coding | List of Recipient IDs | 20130516 | tty_notif_rec_id TYPE STANDARD TABLE OF ty_notif_rec_id WITH DEFAULT KEY
|
|
| 2 | TY_NOTIF_REC_ID | Public | See coding | Recipient ID | 20130516 | ty_notif_rec_id(254) TYPE c
|
|
| 3 | TY_RETRY_FLAG | Public | Type reference (TYPE) | CHAR10 | Retry Flag | 20130516 | |
| 4 | TY_S_FEED_ACTIVITYSTREAMS | Public | See coding | Feed in activitystrea.ms (ABAP format) | 20130516 | BEGIN OF ty_s_feed_activitystreams,
title TYPE string,
published TYPE xsddatetime_z,
author TYPE ty_s_feed_author_as,
verb TYPE string,
object TYPE ty_s_feed_object_as,
source TYPE ty_s_feed_source,
distribute_to TYPE string,
distribute_to_list TYPE tty_notif_rec_id,
content TYPE string,
END OF ty_s_feed_activitystreams
|
|
| 5 | TY_S_FEED_AUTHOR | Public | See coding | Feed Author (activitystrea.ms Format) | 20130516 | BEGIN OF ty_s_feed_author,
id TYPE string, "mandatory, SAP user
name TYPE string, "optional, needs not to be supplied for internal users
email TYPE string, "optional,needs to be supplie only for external users
END OF ty_s_feed_author
|
|
| 6 | TY_S_FEED_AUTHOR_AS | Public | See coding | 20130516 | BEGIN OF ty_s_feed_author_as,
id TYPE string,
name TYPE string,
email TYPE string,
object_type TYPE string,
END OF ty_s_feed_author_as
|
||
| 7 | TY_S_FEED_EXCEPTION | Public | See coding | Feed Exception | 20130516 | BEGIN OF ty_s_feed_exception,
application_id TYPE clb2_application_id,
lx_feed TYPE REF TO cx_clb2_feed,
END OF ty_s_feed_exception
|
|
| 8 | TY_S_FEED_OBJECT | Public | See coding | 20130516 | BEGIN OF ty_s_feed_object,
title TYPE string, "mandatory
link_ui TYPE string, "optional
link_metadata TYPE string, "optional, filled by SAIL if empty (from base_url)
link_annotation TYPE string, "optional
END OF ty_s_feed_object
|
||
| 9 | TY_S_FEED_OBJECT_AS | Public | See coding | Feed Object (activitystrea.ms Format) | 20130516 | BEGIN OF ty_s_feed_object_as,
id TYPE string,
title TYPE string,
object_type TYPE string,
link_ui TYPE string,
link_metadata TYPE string,
link_odata TYPE string,
link_annotation TYPE string,
END OF ty_s_feed_object_as
|
|
| 10 | TY_S_FEED_SOURCE | Public | See coding | Feed Source (activitystrea.ms Format) | 20130516 | BEGIN OF ty_s_feed_source,
title TYPE string,
link TYPE string,
END OF ty_s_feed_source
|
|
| 11 | TY_S_JSON_HEADER | Public | See coding | JSON Header of a Gateway Notification, in ABAP | 20130516 | BEGIN OF ty_s_json_header,
author TYPE ty_s_feed_author,
object TYPE ty_s_feed_object,
verb TYPE string, "optional
summary TYPE string, "optional
END OF ty_s_json_header
|
|
| 12 | TY_S_NOTIFICATION_EXT | Public | See coding | Notification (Gateway) - Extended Format | 20130516 | BEGIN OF ty_s_notification_ext.
INCLUDE TYPE ty_s_notification_feed_hdr.
TYPES: base_url TYPE string,
service_root TYPE icfname,
json_header TYPE string, "JSON formatted header information
content_uri TYPE string,
proctimest TYPE timestampl,
retry_count TYPE i, " Number of retries which have been performed
retry_flag TYPE ty_retry_flag, " some additional flag about the retry type
END OF ty_s_notification_ext
|
|
| 13 | TY_S_NOTIFICATION_FEED | Public | See coding | Notification (Gateway) | 20130516 | BEGIN OF ty_s_notification_feed.
INCLUDE TYPE ty_s_notification_feed_hdr.
TYPES: base_url TYPE string,
service_root TYPE icfname,
json_header TYPE string, "JSON formatted header information
content_uri TYPE string,
END OF ty_s_notification_feed
|
|
| 14 | TY_S_NOTIFICATION_FEED_HDR | Public | See coding | Notification Header (Gateway) | 20130516 | BEGIN OF ty_s_notification_feed_hdr,
type TYPE char1, " notification type id or data
operation_type TYPE char30, " operation type
entries_of_interest TYPE string, " entries of interest e.g. used in badge info
timestamp TYPE tzntstmps, " timestamp of delivery data
text TYPE string, " notification text; used as title
language TYPE sy-langu, " notification text language
service_name TYPE string,
service_namespace TYPE string,
service_version TYPE numc4,
collection TYPE string,
expand TYPE string,
recipients TYPE ty_t_recipients_feed,
END OF ty_s_notification_feed_hdr
|
|
| 15 | TY_S_RECIPIENT_FEED | Public | See coding | Recipient Feed (Gateway) | 20130516 | BEGIN OF ty_s_recipient_feed,
username TYPE syuname,
endpoint TYPE string,
notif_format TYPE string,
trgt_recipient TYPE c LENGTH 112,
END OF ty_s_recipient_feed
|
|
| 16 | TY_T_FEED_EXCEPTION | Public | See coding | List of Feed Exceptions | 20130516 | ty_t_feed_exception TYPE STANDARD TABLE OF ty_s_feed_exception WITH DEFAULT KEY
|
|
| 17 | TY_T_NOTIFICATIONS_EXT | Public | See coding | List of Notifications (Gateway) - Extended Format | 20130516 | ty_t_notifications_ext TYPE STANDARD TABLE OF ty_s_notification_ext WITH DEFAULT KEY
|
|
| 18 | TY_T_NOTIFICATIONS_FEED | Public | See coding | List of Notifications (Gateway) | 20130516 | ty_t_notifications_feed TYPE STANDARD TABLE OF ty_s_notification_feed WITH DEFAULT KEY
|
|
| 19 | TY_T_RECIPIENTS_FEED | Public | See coding | List of Recipient Feeds (Gateway) | 20130516 | ty_t_recipients_feed TYPE STANDARD TABLE OF ty_s_recipient_feed WITH DEFAULT KEY
|
Method Signatures
Method DISTRIBUTE_NOTIFICATIONS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Exporting |
ET_EXCEPTIONS | Call by reference | Type reference (TYPE) | IF_CLB2_FEED_GW=>TY_T_FEED_EXCEPTION | Exceptions | 20130516 | ||
| 2 | Exporting |
ET_NOTIFICATION_RETRY | Call by reference | Type reference (TYPE) | IF_CLB2_FEED_GW=>TY_T_NOTIFICATIONS_EXT | 20130516 | |||
| 3 |  Importing |
IS_NOTIFY_APP | Call by reference | Type reference (TYPE) | IF_CLB2_CUST_QUERIES=>TY_S_APPLI_PLATF | Application/Platform for Notification | 20130516 | ||
| 4 | Importing |
IT_NOTIFICATION_RETRY | Call by reference | Type reference (TYPE) | IF_CLB2_FEED_GW=>TY_T_NOTIFICATIONS_EXT | 20130516 | |||
| 5 | Importing |
IT_ODATA_NOTIFICATION | Call by reference | Type reference (TYPE) | IF_CLB2_FEED_GW=>TY_T_NOTIFICATIONS_FEED | List fo Notifications (Gateway) | 20130516 |
Method DISTRIBUTE_NOTIFICATIONS on Interface IF_CLB2_FEED_GW has no exception.
Method ERROR_HANDLING Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IS_NOTIFY_APP | Call by reference | Type reference (TYPE) | IF_CLB2_CUST_QUERIES=>TY_S_APPLI_PLATF | 20130516 | |||
| 2 | Importing |
IT_EXCEPTIONS | Call by reference | Type reference (TYPE) | IF_CLB2_FEED_GW=>TY_T_FEED_EXCEPTION | 20130516 | |||
| 3 | Importing |
IT_NOTIFICATION_RETRY | Call by reference | Type reference (TYPE) | IF_CLB2_FEED_GW=>TY_T_NOTIFICATIONS_EXT | 20130516 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 |  CX_CLB2_FEED |
20130516 |
Method ERROR_HANDLING_RETRY Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IS_NOTIFY_APP | Call by reference | Type reference (TYPE) | IF_CLB2_CUST_QUERIES=>TY_S_APPLI_PLATF | 20130516 | |||
| 2 | Importing |
IT_EXCEPTIONS | Call by reference | Type reference (TYPE) | IF_CLB2_FEED_GW=>TY_T_FEED_EXCEPTION | 20130516 | |||
| 3 | Importing |
IT_NOTIFICATION_RETRY | Call by reference | Type reference (TYPE) | IF_CLB2_FEED_GW=>TY_T_NOTIFICATIONS_EXT | 20130516 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_CLB2_FEED |
20130516 |
Method POST_USER_FEED Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Exporting |
ET_EXCEPTIONS | Call by reference | Type reference (TYPE) | IF_CLB2_FEED_GW=>TY_T_FEED_EXCEPTION | 20130516 | |||
| 2 | Exporting |
ET_NOTIFICATION_RETRY | Call by reference | Type reference (TYPE) | IF_CLB2_FEED_GW=>TY_T_NOTIFICATIONS_EXT | 20130516 | |||
| 3 | Importing |
IS_NOTIFY_APP | Call by reference | Type reference (TYPE) | IF_CLB2_CUST_QUERIES=>TY_S_APPLI_PLATF | 20130516 | |||
| 4 | Importing |
IT_ODATA_NOTIFICATION | Call by reference | Type reference (TYPE) | IF_CLB2_FEED_GW=>TY_T_NOTIFICATIONS_EXT | List fo Notifications (Gateway) | 20130516 | ||
| 5 | Importing |
IV_ACTIVITYSTREAMS | Call by reference | Type reference (TYPE) | XSTRING | 20130516 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_CLB2_RUNTIME |
SAP Jam Runtime exceptions | 20130516 |
History
| Last changed by/on | SAP | 20141120 |
| SAP Release Created in | 100 |
