Methods summary
public static
Genetsis\core\activityid\Response
|
#
Participate( Genetsis\core\activityid\Request $request )
Genetsis ID user participate actively in a promotion.
This interaction is generated by an application after verify that the requirements for participation in the promotion are met.
Indicates that Genetsis ID user has requested the object. It is very important for the agency to call this method when the agency has successfully registered the participation in its application, to avoid method calls that do not correspond with real participations
Genetsis ID user participate actively in a promotion.
This interaction is generated by an application after verify that the requirements for participation in the promotion are met.
Indicates that Genetsis ID user has requested the object. It is very important for the agency to call this method when the agency has successfully registered the participation in its application, to avoid method calls that do not correspond with real participations
Parameters
- $request
$request->setUserId: (optional) Id of Genetsis ID user (ckusid) who participates in the promotion, if ckusid is not specified, the user logged is sent, but you must check if an user is connected.
$request->setSectionName: (optional) If you have only one section or is the default section, you do not need pass it. The section received is located in oauthconf.xml file.
$request->setSource: (optional) You can set the Device (pc, tablet, mobile,...) origin of the interaction, If source is not specified by default UserAgent is sent. Returns
Genetsis\core\activityid\ResponseReturn a list of InteractionsObject. The list contains one object corresponding to each object created or used in the interaction. Each object contains the object id and the object type. In this case is the object id of the promotion associated to the section
Throws
Exception
If there is an error in the response.
|
public static
Genetsis\core\activityid\Response
|
#
rejectParticipation( Genetsis\core\activityid\Request $request )
An administrator rejects the participation of a user that not fulfilled a condition of participation in a promotion.
Indicates that the administrator has rejected the participation in the promotion. Its commonly used for promotions that require a vertification of the participation (i.e: a consumer must upload a photo to participate, and a moderator must deny it in because is invalid for the promotion
An administrator rejects the participation of a user that not fulfilled a condition of participation in a promotion.
Indicates that the administrator has rejected the participation in the promotion. Its commonly used for promotions that require a vertification of the participation (i.e: a consumer must upload a photo to participate, and a moderator must deny it in because is invalid for the promotion
Parameters
- $request
$request->setSectionName: (optional) If you have only one section or is the default section, you do not need pass it. The section received is located in oauthconf.xml file.
$request->setSource: (optional) You can set the Device (pc, tablet, mobile,...) origin of the interaction, If source is not specified by default UserAgent is sent. Returns
Genetsis\core\activityid\ResponseReturn a list of InteractionsObject. The list contains one object corresponding to each object created or used in the interaction. Each object contains the object id and the object type. In this case is the object id of the promotion associated to the section
Throws
Exception
If there is an error in the response.
|
public static
Genetsis\core\activityid\Response
|
#
winPrize( Genetsis\core\activityid\Request $request )
Genetsis ID user wins a prize from a promotion.
Indicates that Genetsis ID user has won the prize. This verb is typically applicable only when the object represents some form of promotion.
The prize MUST be registered in your configuration by an administrator during the activity on boarding proccess
Genetsis ID user wins a prize from a promotion.
Indicates that Genetsis ID user has won the prize. This verb is typically applicable only when the object represents some form of promotion.
The prize MUST be registered in your configuration by an administrator during the activity on boarding proccess
Parameters
- $request
$request->setUserId: (optional) Id of Genetsis ID user (ckusid) who participates in the promotion, if ckusid is not specified, the user logged is sent, but previously you must check if an user is connected.
$request->setSectionName: (optional) If you have only one section or is the default section, you do not need pass it. The section received is located in oauthconf.xml file.
$request->setSource: (optional) You can set the Device (pc, tablet, mobile,...) origin of the interaction, If source is not specified by default UserAgent is sent.
$request-> Returns
Genetsis\core\activityid\ResponseReturn a list of InteractionsObject. The list contains one object corresponding to each object created or used in the interaction. Each object contains the object id and the object type. In this case is the object id of the unit prize contained by the prize, and used in the interaction
Throws
Exception
If there is an error in the response.
|
public static
Genetsis\core\activityid\Response
|
#
share( Genetsis\core\activityid\Request $request )
Genetsis ID user share content on social networks or through other digital media.
Indicates that Genetsis ID user has called out the object to readers.
In most cases, Genetsis ID user did not create the object being shared, but is instead drawing attention to it.
The activityObject can be an object of type Video, Image, Audio, Comment, Article or Note.
The interaction is considered done by the logged user
Genetsis ID user share content on social networks or through other digital media.
Indicates that Genetsis ID user has called out the object to readers.
In most cases, Genetsis ID user did not create the object being shared, but is instead drawing attention to it.
The activityObject can be an object of type Video, Image, Audio, Comment, Article or Note.
The interaction is considered done by the logged user
Parameters
- $request
$request->setUserId: (optional) Id of Genetsis ID user (ckusid) who participates in the promotion, if ckusid is not specified, the user logged is sent, but previously you must check if an user is connected.
$request->setSectionName: (optional) If you have only one section or is the default section, you do not need pass it. The section received is located in oauthconf.xml file.
$request->setSource: (optional) You can set the Device (pc, tablet, mobile,...) origin of the interaction, If source is not specified by default UserAgent is sent. Returns
Genetsis\core\activityid\ResponseReturn a list of InteractionsObject. The list contains one object corresponding to each object created or used in the interaction. Each object contains the object id and the object type. The id of the objects must be persisted in the agency database in order to generate future interactions that refers this objects (i.e: report a content)
Throws
Exception
If there is an error in the response.
|
public static
Genetsis\core\activityid\Response
|
#
fillSurvey( Genetsis\core\activityid\Request $request )
Genetsis ID user has completed a question or a poll.
Genetsis ID user has completed a question or a poll.
Parameters
- $request
$request->setUserId: (optional) Id of Genetsis ID user (ckusid) who participates in the promotion, if ckusid is not specified, the user logged is sent, but previously you must check if an user is connected.
$request->setSectionName: (optional) If you have only one section or is the default section, you do not need pass it. The section received is located in oauthconf.xml file.
$request->setSource: (optional) You can set the Device (pc, tablet, mobile,...) origin of the interaction, If source is not specified by default UserAgent is sent. Returns
Throws
Exception
If there is an error in the response.
|
public static
Genetsis\core\activityid\Response
|
#
uploadUGC( Genetsis\core\activityid\Request $request )
Genetsis ID user upload a content of type: video, image or audio. Indicates that Genetsis ID user has created the object.
Genetsis ID user upload a content of type: video, image or audio. Indicates that Genetsis ID user has created the object.
Parameters
- $request
$request->setUserId: (optional) Id of Genetsis ID user (ckusid) who participates in the promotion, if ckusid is not specified, the user logged is sent, but previously you must check if an user is connected.
$request->setSectionName: (optional) If you have only one section or is the default section, you do not need pass it. The section received is located in oauthconf.xml file.
$request->setSource: (optional) You can set the Device (pc, tablet, mobile,...) origin of the interaction, If source is not specified by default UserAgent is sent. Returns
Throws
Exception
If there is an error in the response.
|
public static
Genetsis\core\activityid\Response
|
#
deleteUGC( Genetsis\core\activityid\Request $request )
Genetsis ID user delete a previously uploaded content of type: video, image or audio. Indicates that Genetsis ID user has deleted the object.
Genetsis ID user delete a previously uploaded content of type: video, image or audio. Indicates that Genetsis ID user has deleted the object.
Parameters
- $request
$request->setUserId: (optional) Id of Genetsis ID user (ckusid) who participates in the promotion, if ckusid is not specified, the user logged is sent, but previously you must check if an user is connected.
$request->setSectionName: (optional) If you have only one section or is the default section, you do not need pass it. The section received is located in oauthconf.xml file.
$request->setSource: (optional) You can set the Device (pc, tablet, mobile,...) origin of the interaction, If source is not specified by default UserAgent is sent. Returns
Throws
Exception
If there is an error in the response.
|
public static
Genetsis\core\activityid\Response
|
#
rejectUGC( Genetsis\core\activityid\Request $request )
Genetsis ID user (system moderator) reject a previously uploaded content of type: video, image or audio.
Genetsis ID user (system moderator) reject a previously uploaded content of type: video, image or audio.
Parameters
- $request
$request->setSectionName: (optional) If you have only one section or is the default section, you do not need pass it. The section received is located in oauthconf.xml file.
$request->setSource: (optional) You can set the Device (pc, tablet, mobile,...) origin of the interaction, If source is not specified by default UserAgent is sent. Returns
Throws
Exception
If there is an error in the response.
|
public static
Genetsis\core\activityid\Response
|
#
voteUGC( Genetsis\core\activityid\Request $request )
The actor votes for a user-generated content.
Related to an objectType Rating, given as a number between 1.0 and 5.0 inclusive with one decimal place of precision.
The actor votes for a user-generated content.
Related to an objectType Rating, given as a number between 1.0 and 5.0 inclusive with one decimal place of precision.
Parameters
- $request
$request->setUserId: (optional) Id of Genetsis ID user (ckusid) who participates in the promotion, if ckusid is not specified, the user logged is sent, but previously you must check if an user is connected.
$request->setSectionName: (optional) If you have only one section or is the default section, you do not need pass it. The section received is located in oauthconf.xml file.
$request->setSource: (optional) You can set the Device (pc, tablet, mobile,...) origin of the interaction, If source is not specified by default UserAgent is sent. Returns
Throws
Exception
If there is an error in the response.
|
public static
Genetsis\core\activityid\Response
|
#
editUGC( Genetsis\core\activityid\Request $request )
The actor has updated or modified the object. The use of the update verb is generally reserved to indicate modifications
to existing objects or data such as changing an existing user's profile information.
The actor has updated or modified the object. The use of the update verb is generally reserved to indicate modifications
to existing objects or data such as changing an existing user's profile information.
Parameters
Returns
Throws
Exception
If there is an error in the response.
|
public static
Genetsis\core\activityid\Response
|
#
viewUGC( Genetsis\core\activityid\Request $request )
The actor has consumed the object. The object.objectType property may take the value: video, image or audio.
The specific meaning is dependent largely on the object's type.
For instance, an actor may "consume" an audio object, indicating that the actor has listened to it;
or an actor may "consume" a video, indicating that the video has been watched.
The actor has consumed the object. The object.objectType property may take the value: video, image or audio.
The specific meaning is dependent largely on the object's type.
For instance, an actor may "consume" an audio object, indicating that the actor has listened to it;
or an actor may "consume" a video, indicating that the video has been watched.
Parameters
Returns
Throws
Exception
If there is an error in the response.
|
public static
Genetsis\core\activityid\Response
|
#
report( Genetsis\core\activityid\Request $request )
The actor report a violation of privacy or terms and conditions of a content.
Indicates that the actor has flagged the object as being inappropriate for some reason.
The context property can be used to provide additional detail about why the object has been flagged.
Related to an objectType: issue, that represents a report about a problem or situation that needs to be resolved.
The actor report a violation of privacy or terms and conditions of a content.
Indicates that the actor has flagged the object as being inappropriate for some reason.
The context property can be used to provide additional detail about why the object has been flagged.
Related to an objectType: issue, that represents a report about a problem or situation that needs to be resolved.
The context property is defined in the Context section of the Activity Streams Schema.
The context.type property CAN use one of the following values: advertisingContent, violentAbusiveOffensive,
sexualInappropriateProhibited, meWithoutPermission, sendMeAdvertising, sendMeInappropriateProhibited or threateningHarassingInsultingMe
Parameters
Returns
Throws
Exception
If there is an error in the response.
|
public static
Genetsis\core\activityid\Response
|
#
follow( Genetsis\core\activityid\Request $request )
The actor follow an account managed by TCCC on Twitter.
The object.objectType person, represents an account managed by TCCC.
Indicates that the actor began following the activity of the object.
The actor follow an account managed by TCCC on Twitter.
The object.objectType person, represents an account managed by TCCC.
Indicates that the actor began following the activity of the object.
Parameters
Returns
Throws
Exception
If there is an error in the response.
|
public static
Genetsis\core\activityid\Response
|
#
like( Genetsis\core\activityid\Request $request )
The actor has marked in a positive way a content. Indicates that the actor marked the object as an item of special interest.
The actor has marked in a positive way a content. Indicates that the actor marked the object as an item of special interest.
Parameters
Returns
Throws
Exception
If there is an error in the response.
|
public static
Genetsis\core\activityid\Response
|
#
unlike( Genetsis\core\activityid\Request $request )
The actor stopped marking positively a content. Indicates that the actor has removed the object from the collection of liked items
The actor stopped marking positively a content. Indicates that the actor has removed the object from the collection of liked items
Parameters
Returns
Throws
Exception
If there is an error in the response.
|
public static
Genetsis\core\activityid\Response
|
#
voteBrandContent( Genetsis\core\activityid\Request $request )
Same as Vote UGC, except that the content was generated by TCCC, referred by the target property.
Indicates that the actor votes for a Brand-generated content.
Related to an objectType Rating, given as a number between 1.0 and 5.0 inclusive with one decimal place of precision.
Same as Vote UGC, except that the content was generated by TCCC, referred by the target property.
Indicates that the actor votes for a Brand-generated content.
Related to an objectType Rating, given as a number between 1.0 and 5.0 inclusive with one decimal place of precision.
Parameters
Returns
Throws
Exception
If there is an error in the response.
|
public static
Genetsis\core\activityid\Response
|
#
viewBrandContent( Genetsis\core\activityid\Request $request )
Same as View UGC, except that the content was generated by TCCC, referred by the target property.
Indicates that the actor has consumed the object.
The object.objectType property may take the value: video, image or audio
Same as View UGC, except that the content was generated by TCCC, referred by the target property.
Indicates that the actor has consumed the object.
The object.objectType property may take the value: video, image or audio
Parameters
Returns
Throws
Exception
If there is an error in the response.
|
public static
Genetsis\core\activityid\Response
|
|
public static
Genetsis\core\activityid\Response
|
#
eventAttendance( Genetsis\core\activityid\Request $request )
The actor has participate in a physical or digital event generated by TCCC and is not in POS (Point of Sale).
Indicates that the actor has attended the object
The actor has participate in a physical or digital event generated by TCCC and is not in POS (Point of Sale).
Indicates that the actor has attended the object
Parameters
Returns
Throws
Exception
If there is an error in the response.
|
public static
Genetsis\core\activityid\Response
|
#
makeFriend( Genetsis\core\activityid\Request $request )
The actor has created a friendship that is reciprocated by the object. Since this verb implies an
activity on the part of its object, processors MUST NOT accept activities with this verb unless they
are able to verify through some external means that there is in fact a reciprocated connection.
For example, a processor may have received a guarantee from a particular publisher that the publisher
will only use this Verb in cases where a reciprocal relationship exists.
The actor has created a friendship that is reciprocated by the object. Since this verb implies an
activity on the part of its object, processors MUST NOT accept activities with this verb unless they
are able to verify through some external means that there is in fact a reciprocated connection.
For example, a processor may have received a guarantee from a particular publisher that the publisher
will only use this Verb in cases where a reciprocal relationship exists.
Parameters
Returns
Throws
Exception
If there is an error in the response.
|
public static
Genetsis\core\activityid\Response
|
#
downloadCoupon( Genetsis\core\activityid\Request $request )
The actor has downloaded a free coupon from TCCC.
Indicates that the actor is receiving an object.
The object identifies the object being received.
The actor has downloaded a free coupon from TCCC.
Indicates that the actor is receiving an object.
The object identifies the object being received.
Parameters
Returns
Throws
Exception
If there is an error in the response.
|
public static
Genetsis\core\activityid\Response
|
#
downloadCouponPOS( Genetsis\core\activityid\Request $request )
Same as Download Coupon, except that the location property MUST be fulfilled.
The actor has downloaded a free coupon from TCCC.
Indicates that the actor is receiving an object. The object identifies the object being received.
The location property is defined in the Location section of the Activity Stream Schema.
Same as Download Coupon, except that the location property MUST be fulfilled.
The actor has downloaded a free coupon from TCCC.
Indicates that the actor is receiving an object. The object identifies the object being received.
The location property is defined in the Location section of the Activity Stream Schema.
Parameters
Returns
Throws
Exception
If there is an error in the response.
|
public static
Genetsis\core\activityid\Response
|
#
redeemCouponPOS( Genetsis\core\activityid\Request $request )
The actor has Redeem a Coupon purchased or Downloaded at the Point of Sale of TCCC.
Indicates that the actor has consumed the object from a Geo-Location.
The location property MUST be fulfilled as defined in the Location section of the Activity Stream Schema.
The object.id CAN be an id created as a result of an previously Downloaded / Redeemed Coupon or any other id from their own POS system.
In Location info, an Address OR a Position are mandatory
The actor has Redeem a Coupon purchased or Downloaded at the Point of Sale of TCCC.
Indicates that the actor has consumed the object from a Geo-Location.
The location property MUST be fulfilled as defined in the Location section of the Activity Stream Schema.
The object.id CAN be an id created as a result of an previously Downloaded / Redeemed Coupon or any other id from their own POS system.
In Location info, an Address OR a Position are mandatory
Parameters
Returns
Throws
Exception
If there is an error in the response.
|
public static
Genetsis\core\activityid\Response
|
#
checkIn( Genetsis\core\activityid\Request $request )
The actor has checked-in to the object. For instance, a person checking-in to a Place.
Indicates that the actor share branded user's geographical location at a POS.
The place property MUST be fulfilled as defined in the Place section of the Activity Stream Schema.
The actor has checked-in to the object. For instance, a person checking-in to a Place.
Indicates that the actor share branded user's geographical location at a POS.
The place property MUST be fulfilled as defined in the Place section of the Activity Stream Schema.
Parameters
Returns
Throws
Exception
If there is an error in the response.
|