stack

Home > @infiniteobjects/shopify-data-manager > AdminTypes > CommentEvent

AdminTypes.CommentEvent interface

Comment events are generated by staff members of a shop. They are created when a staff member adds a comment to the timeline of an order, draft order, customer, or transfer.

Signature:

export interface CommentEvent extends Event, Node 

Extends: Event, Node

Properties

Property Modifiers Type Description
appTitle?   Maybe<Scalars[‘String’][‘output’]> (Optional) The name of the app that created the event.
attachments   Array<CommentEventAttachment> The attachments associated with the comment event.
attributeToApp   Scalars[‘Boolean’][‘output’] Whether the event was created by an app.
attributeToUser   Scalars[‘Boolean’][‘output’] Whether the event was caused by an admin user.
author   StaffMember The name of the user that authored the comment event.
canDelete   Scalars[‘Boolean’][‘output’] Whether the comment event can be deleted. If true, then the comment event can be deleted.
canEdit   Scalars[‘Boolean’][‘output’] Whether the comment event can be edited. If true, then the comment event can be edited.
createdAt   Scalars[‘DateTime’][‘output’] The date and time when the event was created.
criticalAlert   Scalars[‘Boolean’][‘output’] Whether the event is critical.
edited   Scalars[‘Boolean’][‘output’] Whether the comment event has been edited. If true, then the comment event has been edited.
embed?   Maybe<CommentEventEmbed> (Optional) The object reference associated with the comment event. For example, a product or discount).
id   Scalars[‘ID’][‘output’] A globally-unique ID.
message   Scalars[‘FormattedString’][‘output’] Human readable text that describes the event.
rawMessage   Scalars[‘String’][‘output’] The raw body of the comment event.
subject   CommentEventSubject The parent subject to which the comment event belongs.