Interface Verbs


  • @ProviderType
    public interface Verbs
    Defines the well known verbs as specified in http://activitystrea.ms/specs/json/schema/activity-schema.html#verbs
    • Field Summary

      Fields 
      Modifier and Type Field Description
      static String ACCEPT
      Indicates that that the actor has accepted the object.
      static String ACCESS
      * Indicates that the actor has accessed the object.
      static String ACKNOWLEDGE
      Indicates that the actor has acknowledged the object.
      static String ADD
      Indicates that the actor has added the object to the target.
      static String AGREE
      Indicates that the actor agrees with the object.
      static String APPEND
      Indicates that the actor has appended the object to the target.
      static String APPROVE
      Indicates that the actor has approved the object.
      static String ARCHIVE
      Indicates that the actor has archived the object.
      static String ASSIGN
      Indicates that the actor has assigned the object to the target.
      static String AT
      Indicates that the actor is currently located at the object.
      static String ATTACH
      Indicates that the actor has attached the object to the target.
      static String ATTEND
      Indicates that the actor has attended the object.
      static String AUTHOR
      Indicates that the actor has authored the object.
      static String AUTHORIZE
      Indicates that the actor has authorized the object.
      static String BORROW
      Indicates that the actor has borrowed the object.
      static String BUILD
      Indicates that the actor has built the object.
      static String CANCEL
      Indicates that the actor has canceled the object.
      static String CHECKIN
      Indicates that the actor has checked-in to the object.
      static String CLOSE
      Indicates that the actor has closed the object.
      static String COMPLETE
      Indicates that the actor has completed the object.
      static String CONFIRM
      Indicates that the actor has confirmed or agrees with the object.
      static String CONSUME
      Indicates that the actor has consumed the object.
      static String CREATE
      Indicates that the actor has created the object.
      static String DELETE
      Indicates that the actor has deleted the object.
      static String DELIVER
      Indicates that the actor has delivered the object.
      static String DENY
      Indicates that the actor has denied the object.
      static String DISAGREE
      Indicates that the actor disagrees with the object.
      static String DISLIKE
      Indicates that the actor dislikes the object.
      static String EXPERIENCE
      Indicates that the actor has experienced the object in some manner.
      static String FAVORITE
      Indicates that the actor marked the object as an item of special interest.
      static String FIND
      Indicates that the actor has found the object.
      static String FLAG_AS_INAPPROPRIATE
      Indicates that the actor has flagged the object as being inappropriate for some reason.
      static String FOLLOW
      Indicates that the actor began following the activity of the object.
      static String GIVE
      Indicates that the actor is giving an object to the target.
      static String HOST
      Indicates that the actor is hosting the object.
      static String IGNORE
      Indicates that the actor has ignored the object.
      static String INSERT
      Indicates that the actor has inserted the object into the target.
      static String INSTALL
      Indicates that the actor has installed the object, as in installing an application.
      static String INTERACT
      Indicates that the actor has interacted with the object.
      static String INVITE
      Indicates that the actor has invited the object, typically a person object, to join or participate in the object described by the target.
      static String JOIN
      Indicates that the actor has become a member of the object.
      static String LEAVE
      Indicates that the actor has left the object.
      static String LIKE
      Indicates that the actor marked the object as an item of special interest.
      static String LISTEN
      Indicates that the actor has listened to the object.
      static String LOSE
      Indicates that the actor has lost the object.
      static String MAKE_FRIEND
      Indicates the creation of a friendship that is reciprocated by the object.
      static String OPEN
      Indicates that the actor has opened the object.
      static String PLAY
      Indicates that the actor spent some time enjoying the object.
      static String POST
      The "post" verb describes the act of authoring an object and then publishing it online.
      static String PRESENT
      Indicates that the actor has presented the object.
      static String PURCHASE
      Indicates that the actor has purchased the object.
      static String QUALIFY
      Indicates that the actor has qualified for the object.
      static String READ
      Indicates that the actor read the object.
      static String RECEIVE
      Indicates that the actor is receiving an object.
      static String REJECT
      Indicates that the actor has rejected the object.
      static String REMOVE
      Indicates that the actor has removed the object from the collection of friends.
      static String REMOVE_FRIEND
      Indicates that the actor has removed the object from the target.
      static String REPLACE
      Indicates that the actor has replaced the target with the object.
      static String REQUEST
      Indicates that the actor has requested the object.
      static String REQUEST_FRIEND
      Indicates the creation of a friendship that has not yet been reciprocated by the object.
      static String RESOLVE
      Indicates that the actor has resolved the object.
      static String RETRACT_MAYBE
      Indicates that the actor has retracted the object.
      static String RETURN
      Indicates that the actor has returned the object.
      static String RSVP_MAYBE
      The "possible RSVP" verb indicates that the actor has made a possible RSVP for the object.
      static String RSVP_NO
      The "negative RSVP" verb indicates that the actor has made a negative RSVP for the object.
      static String RSVP_YES
      The "positive RSVP" verb indicates that the actor has made a positive RSVP for an object.
      static String SATISFY
      Indicates that the actor has satisfied the object.
      static String SAVE
      Indicates that the actor has called out the object as being of interest primarily to him- or herself.
      static String SCHEDULE
      Indicates that the actor has scheduled the object.
      static String SEARCH
      Indicates that the actor is or has searched for the object.
      static String SELL
      Indicates that the actor has sold the object.
      static String SEND
      Indicates that the actor has sent the object.
      static String SHARE
      Indicates that the actor has called out the object to readers.
      static String SPONSOR
      Indicates that the actor has sponsored the object.
      static String START
      Indicates that the actor has started the object.
      static String STOP_FOLLOWING
      Indicates that the actor has stopped following the object.
      static String SUBMIT
      Indicates that the actor has submitted the object.
      static String TAG
      Indicates that the actor has associated the object with the target.
      static String TERMINATE
      Indicates that the actor has terminated the object.
      static String TIE
      Indicates that the actor has neither won or lost the object.
      static String UNFAVORITE
      Indicates that the actor has removed the object from the collection of favorited items.
      static String UNLIKE
      Indicates that the actor has removed the object from the collection of liked items.
      static String UNSATISFY
      Indicates that the actor has not satisfied the object.
      static String UNSAVE
      Indicates that the actor has removed the object from the collection of saved items.
      static String UNSHARE
      Indicates that the actor is no longer sharing the object.
      static String UPDATE
      The "update" verb indicates that the actor has modified the object.
      static String USE
      Indicates that the actor has used the object in some manner.
      static String WATCH
      Indicates that the actor has watched the object.
      static String WIN
      Indicates that the actor has won the object.
    • Field Detail

      • ACCEPT

        static final String ACCEPT
        Indicates that that the actor has accepted the object. For instance, a person accepting an award, or accepting an assignment.
        See Also:
        Constant Field Values
      • ACCESS

        static final String ACCESS
        * Indicates that the actor has accessed the object. For instance, a person accessing a room, or accessing a file.
        See Also:
        Constant Field Values
      • ACKNOWLEDGE

        static final String ACKNOWLEDGE
        Indicates that the actor has acknowledged the object. This effectively signals that the actor is aware of the object's existence.
        See Also:
        Constant Field Values
      • ADD

        static final String ADD
        Indicates that the actor has added the object to the target. For instance, adding a photo to an album.
        See Also:
        Constant Field Values
      • AGREE

        static final String AGREE
        Indicates that the actor agrees with the object. For example, a person agreeing with an argument, or expressing agreement with a particular issue.
        See Also:
        Constant Field Values
      • APPEND

        static final String APPEND
        Indicates that the actor has appended the object to the target. For instance, a person appending a new record to a database.
        See Also:
        Constant Field Values
      • APPROVE

        static final String APPROVE
        Indicates that the actor has approved the object. For instance, a manager might approve a travel request.
        See Also:
        Constant Field Values
      • AT

        static final String AT
        Indicates that the actor is currently located at the object. For instance, a person being at a specific physical location.
        See Also:
        Constant Field Values
      • ATTACH

        static final String ATTACH
        Indicates that the actor has attached the object to the target. For instance, a person attaching a file to a wiki page or an email.
        See Also:
        Constant Field Values
      • ATTEND

        static final String ATTEND
        Indicates that the actor has attended the object. For instance, a person attending a meeting.
        See Also:
        Constant Field Values
      • AUTHOR

        static final String AUTHOR
        Indicates that the actor has authored the object. Note that this is a more specific form of the verb "create".
        See Also:
        Constant Field Values
      • AUTHORIZE

        static final String AUTHORIZE
        Indicates that the actor has authorized the object. If a target is specified, it means that the authorization is specifically in regards to the target. For instance, a service can authorize a person to access a given application; in which case the actor is the service, the object is the person, and the target is the application. In contrast, a person can authorize a request; in which case the actor is the person and the object is the request and there might be no explicit target.
        See Also:
        Constant Field Values
      • BORROW

        static final String BORROW
        Indicates that the actor has borrowed the object. If a target is specified, it identifies the entity from which the object was borrowed. For instance, if a person borrows a book from a library, the person is the actor, the book is the object and the library is the target.
        See Also:
        Constant Field Values
      • BUILD

        static final String BUILD
        Indicates that the actor has built the object. For example, if a person builds a model or compiles code.
        See Also:
        Constant Field Values
      • CANCEL

        static final String CANCEL
        Indicates that the actor has canceled the object. For instance, canceling a calendar event.
        See Also:
        Constant Field Values
      • CLOSE

        static final String CLOSE
        Indicates that the actor has closed the object. For instance, the object could represent a ticket being tracked in an issue management system.
        See Also:
        Constant Field Values
      • CONFIRM

        static final String CONFIRM
        Indicates that the actor has confirmed or agrees with the object. For instance, a software developer might confirm an issue reported against a product.
        See Also:
        Constant Field Values
      • CONSUME

        static final String CONSUME
        Indicates that the actor has consumed the object. 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 book, indicating that the book has been read. As such, the "consume" verb is a more generic form of other more specific verbs such as "read" and "play".
        See Also:
        Constant Field Values
      • CHECKIN

        static final String CHECKIN
        Indicates that the actor has checked-in to the object. For instance, a person checking-in to a Place.
        See Also:
        Constant Field Values
      • DELETE

        static final String DELETE
        Indicates that the actor has deleted the object. This implies, but does not require, the permanent destruction of the object.
        See Also:
        Constant Field Values
      • DELIVER

        static final String DELIVER
        Indicates that the actor has delivered the object. For example, delivering a package.
        See Also:
        Constant Field Values
      • DENY

        static final String DENY
        Indicates that the actor has denied the object. For example, a manager may deny a travel request.
        See Also:
        Constant Field Values
      • DISLIKE

        static final String DISLIKE
        Indicates that the actor dislikes the object. Note that the "dislike" verb is distinct from the "unlike" verb which assumes that the object had been previously "liked".
        See Also:
        Constant Field Values
      • EXPERIENCE

        static final String EXPERIENCE
        Indicates that the actor has experienced the object in some manner. Note that, depending on the specific object types used for both the actor and object, the meaning of this verb can overlap that of the "consume" and "play" verbs. For instance, a person might "experience" a movie; or "play" the movie; or "consume" the movie. The "experience" verb SHOULD be considered a more generic form of other more specific verbs as "consume", "play", "watch", "listen", and "read"
        See Also:
        Constant Field Values
      • FAVORITE

        static final String FAVORITE
        Indicates that the actor marked the object as an item of special interest.
        See Also:
        Constant Field Values
      • FIND

        static final String FIND
        Indicates that the actor has found the object. If a target is specified, it SHOULD indicate where the object was found.
        See Also:
        Constant Field Values
      • FLAG_AS_INAPPROPRIATE

        static final String FLAG_AS_INAPPROPRIATE
        Indicates that the actor has flagged the object as being inappropriate for some reason. When using this verb, the context property, as specified within Section 4.1 can be used to provide additional detail about why the object has been flagged.
        See Also:
        Constant Field Values
      • FOLLOW

        static final String FOLLOW
        Indicates that the actor began following the activity of the object. In most cases, the objectType will be a "person", but it can potentially be of any type that can sensibly generate activity. Processors MAY ignore (silently drop) successive identical "follow" activities.
        See Also:
        Constant Field Values
      • GIVE

        static final String GIVE
        Indicates that the actor is giving an object to the target. Examples include one person giving a badge object to another person. The object identifies the object being given. The target identifies the receiver.
        See Also:
        Constant Field Values
      • HOST

        static final String HOST
        Indicates that the actor is hosting the object. As in hosting an event, or hosting a service.
        See Also:
        Constant Field Values
      • IGNORE

        static final String IGNORE
        Indicates that the actor has ignored the object. For instance, this verb may be used when an actor has ignored a friend request, in which case the object may be the request-friend activity.
        See Also:
        Constant Field Values
      • INSTALL

        static final String INSTALL
        Indicates that the actor has installed the object, as in installing an application.
        See Also:
        Constant Field Values
      • INTERACT

        static final String INTERACT
        Indicates that the actor has interacted with the object. For instance, when one person interacts with another.
        See Also:
        Constant Field Values
      • INVITE

        static final String INVITE
        Indicates that the actor has invited the object, typically a person object, to join or participate in the object described by the target. The target could, for instance, be an event, group or a service.
        See Also:
        Constant Field Values
      • JOIN

        static final String JOIN
        Indicates that the actor has become a member of the object. This specification only defines the meaning of this verb when the object of the Activity has an objectType of group, though implementors SHOULD be prepared to handle other types of objects.
        See Also:
        Constant Field Values
      • LEAVE

        static final String LEAVE
        Indicates that the actor has left the object. For instance, a Person leaving a Group or checking-out of a Place.
        See Also:
        Constant Field Values
      • LIKE

        static final String LIKE
        Indicates that the actor marked the object as an item of special interest. The "like" verb is considered to be an alias of "favorite". The two verb are semantically identical.
        See Also:
        Constant Field Values
      • LISTEN

        static final String LISTEN
        Indicates that the actor has listened to the object. This is typically only applicable for objects representing audio content, such as music, and audio-book, or a radio broadcast. The "listen" verb is a more specific form of the "consume", "experience" and "play" verbs.
        See Also:
        Constant Field Values
      • LOSE

        static final String LOSE
        Indicates that the actor has lost the object. For instance, if a person loses a game.
        See Also:
        Constant Field Values
      • MAKE_FRIEND

        static final String MAKE_FRIEND
        Indicates the creation of 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.
        See Also:
        Constant Field Values
      • OPEN

        static final String OPEN
        Indicates that the actor has opened the object. For instance, the object could represent a ticket being tracked in an issue management system.
        See Also:
        Constant Field Values
      • PLAY

        static final String PLAY
        Indicates that the actor spent some time enjoying the object. For example, if the object is a video this indicates that the subject watched all or part of the video. The "play" verb is a more specific form of the "consume" verb.
        See Also:
        Constant Field Values
      • POST

        static final String POST
        The "post" verb describes the act of authoring an object and then publishing it online. The actor can be any entity; the object can be of any object type; and the target, if specified, can be of any object type. A target, however, is not required.
        See Also:
        Constant Field Values
      • PRESENT

        static final String PRESENT
        Indicates that the actor has presented the object. For instance, when a person gives a presentation at a conference.
        See Also:
        Constant Field Values
      • PURCHASE

        static final String PURCHASE
        Indicates that the actor has purchased the object. If a target is specified, in indicates the entity from which the object was purchased.
        See Also:
        Constant Field Values
      • QUALIFY

        static final String QUALIFY
        Indicates that the actor has qualified for the object. If a target is specified, it indicates the context within which the qualification applies.
        See Also:
        Constant Field Values
      • READ

        static final String READ
        Indicates that the actor read the object. This is typically only applicable for objects representing printed or written content, such as a book, a message or a comment. The "read" verb is a more specific form of the "consume", "experience" and "play" verbs.
        See Also:
        Constant Field Values
      • RECEIVE

        static final String RECEIVE
        Indicates that the actor is receiving an object. Examples include a person receiving a badge object. The object identifies the object being received.
        See Also:
        Constant Field Values
      • REMOVE_FRIEND

        static final String REMOVE_FRIEND
        Indicates that the actor has removed the object from the target.
        See Also:
        Constant Field Values
      • REMOVE

        static final String REMOVE
        Indicates that the actor has removed the object from the collection of friends.
        See Also:
        Constant Field Values
      • REPLACE

        static final String REPLACE
        Indicates that the actor has replaced the target with the object.
        See Also:
        Constant Field Values
      • REQUEST

        static final String REQUEST
        Indicates that the actor has requested the object. If a target is specified, it indicates the entity from which the object is being requested.
        See Also:
        Constant Field Values
      • REQUEST_FRIEND

        static final String REQUEST_FRIEND
        Indicates the creation of a friendship that has not yet been reciprocated by the object.
        See Also:
        Constant Field Values
      • RESOLVE

        static final String RESOLVE
        Indicates that the actor has resolved the object. For instance, the object could represent a ticket being tracked in an issue management system.
        See Also:
        Constant Field Values
      • RETURN

        static final String RETURN
        Indicates that the actor has returned the object. If a target is specified, it indicates the entity to which the object was returned.
        See Also:
        Constant Field Values
      • RETRACT_MAYBE

        static final String RETRACT_MAYBE
        Indicates that the actor has retracted the object. For instance, if an actor wishes to retract a previously published activity, the object would be the previously published activity that is being retracted.
        See Also:
        Constant Field Values
      • RSVP_MAYBE

        static final String RSVP_MAYBE
        The "possible RSVP" verb indicates that the actor has made a possible RSVP for the object. This specification only defines the meaning of this verb when its object is an event (see Section 3.3), though implementors SHOULD be prepared to handle other object types as meaning MAY be provided by extension specifications. The use of this verb is only appropriate when the RSVP was created by an explicit action by the actor. It is not appropriate to use this verb when a user has been added as an attendee by an event organiser or administrator.
        See Also:
        Constant Field Values
      • RSVP_NO

        static final String RSVP_NO
        The "negative RSVP" verb indicates that the actor has made a negative RSVP for the object. This specification only defines the meaning of this verb when its object is an event (see Section 3.3), though implementors SHOULD be prepared to handle other object types as meaning MAY be provided by extension specifications. The use of this verb is only appropriate when the RSVP was created by an explicit action by the actor. It is not appropriate to use this verb when a user has been added as an attendee by an event organiser or administrator.
        See Also:
        Constant Field Values
      • RSVP_YES

        static final String RSVP_YES
        The "positive RSVP" verb indicates that the actor has made a positive RSVP for an object. This specification only defines the meaning of this verb when its object is an event (see Section 3.3), though implementors SHOULD be prepared to handle other object types as meaning MAY be provided by extension specifications. The use of this verb is only appropriate when the RSVP was created by an explicit action by the actor. It is not appropriate to use this verb when a user has been added as an attendee by an event organiser or administrator.
        See Also:
        Constant Field Values
      • SATISFY

        static final String SATISFY
        Indicates that the actor has satisfied the object. If a target is specified, it indicate the context within which the object was satisfied. For instance, if a person satisfies the requirements for a particular challenge, the person is the actor; the requirement is the object; and the challenge is the target.
        See Also:
        Constant Field Values
      • SAVE

        static final String SAVE
        Indicates that the actor has called out the object as being of interest primarily to him- or herself. Though this action MAY be shared publicly, the implication is that the object has been saved primarily for the actor's own benefit rather than to show it to others as would be indicated by the "share" verb.
        See Also:
        Constant Field Values
      • SCHEDULE

        static final String SCHEDULE
        Indicates that the actor has scheduled the object. For instance, scheduling a meeting.
        See Also:
        Constant Field Values
      • SEARCH

        static final String SEARCH
        Indicates that the actor is or has searched for the object. If a target is specified, it indicates the context within which the search is or has been conducted.
        See Also:
        Constant Field Values
      • SELL

        static final String SELL
        Indicates that the actor has sold the object. If a target is specified, it indicates the entity to which the object was sold.
        See Also:
        Constant Field Values
      • SEND

        static final String SEND
        Indicates that the actor has sent the object. If a target is specified, it indicates the entity to which the object was sent.
        See Also:
        Constant Field Values
      • SHARE

        static final String SHARE
        Indicates that the actor has called out the object to readers. In most cases, the actor did not create the object being shared, but is instead drawing attention to it.
        See Also:
        Constant Field Values
      • SPONSOR

        static final String SPONSOR
        Indicates that the actor has sponsored the object. If a target is specified, it indicates the context within which the sponsorship is offered. For instance, a company can sponsor an event; or an individual can sponsor a project; etc.
        See Also:
        Constant Field Values
      • START

        static final String START
        Indicates that the actor has started the object. For instance, when a person starts a project.
        See Also:
        Constant Field Values
      • STOP_FOLLOWING

        static final String STOP_FOLLOWING
        Indicates that the actor has stopped following the object.
        See Also:
        Constant Field Values
      • SUBMIT

        static final String SUBMIT
        Indicates that the actor has submitted the object. If a target is specified, it indicates the entity to which the object was submitted.
        See Also:
        Constant Field Values
      • TAG

        static final String TAG
        Indicates that the actor has associated the object with the target. For example, if the actor specifies that a particular user appears in a photo. the object is the user and the target is the photo.
        See Also:
        Constant Field Values
      • TIE

        static final String TIE
        Indicates that the actor has neither won or lost the object. This verb is generally only applicable when the object represents some form of competition, such as a game.
        See Also:
        Constant Field Values
      • UNFAVORITE

        static final String UNFAVORITE
        Indicates that the actor has removed the object from the collection of favorited items.
        See Also:
        Constant Field Values
      • UNLIKE

        static final String UNLIKE
        Indicates that the actor has removed the object from the collection of liked items.
        See Also:
        Constant Field Values
      • UNSATISFY

        static final String UNSATISFY
        Indicates that the actor has not satisfied the object. If a target is specified, it indicates the context within which the object was not satisfied. For instance, if a person fails to satisfy the requirements of some particular challenge, the person is the actor; the requirement is the object and the challenge is the target.
        See Also:
        Constant Field Values
      • UNSAVE

        static final String UNSAVE
        Indicates that the actor has removed the object from the collection of saved items.
        See Also:
        Constant Field Values
      • UNSHARE

        static final String UNSHARE
        Indicates that the actor is no longer sharing the object. If a target is specified, it indicates the entity with whom the object is no longer being shared.
        See Also:
        Constant Field Values
      • UPDATE

        static final String UPDATE
        The "update" verb indicates that the actor has modified the object. 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.
        See Also:
        Constant Field Values
      • WATCH

        static final String WATCH
        Indicates that the actor has watched the object. This verb is typically applicable only when the object represents dynamic, visible content such as a movie, a television show or a public performance. This verb is a more specific form of the verbs "experience", "play" and "consume".
        See Also:
        Constant Field Values
      • WIN

        static final String WIN
        Indicates that the actor has won the object. This verb is typically applicable only when the object represents some form of competition, such as a game.
        See Also:
        Constant Field Values