Class RecordPublisher

Name

RecordPublisher

Hierarchy

Publisher
- RecordPublisher

Index

Constructors

Methods

close getSubject isClosed isDiscarded send setDiscardHandler

Constructors

constructor

new RecordPublisher(): RecordPublisher
Returns RecordPublisher

Inherited from Publisher.constructor

Methods

close

close(): void
Closes this subscription

Returns void

Inherited from Publisher.close

getSubject

getSubject(): string
The subject that was requested

Returns string
the subject

Inherited from Publisher.getSubject

isClosed

isClosed(): boolean
Indicates whether this publisher has been closed

Returns boolean
true if closed

Inherited from Publisher.isClosed

isDiscarded

isDiscarded(): boolean
Indicates whether this subjet has been discard by the liberator

Returns boolean
true if discarded

Inherited from Publisher.isDiscarded

send

send(fields, image, commandListener): void
Sends a Message to Liberator for the current subject
Parameters
- fields: {
  [key: string]: string;
  }
  
  the fields to send
  - [key: string]: string
- image: boolean
  
  whether this is an image
- commandListener: CommandListener
  
  an object with callbacks for the success/failure of sending this message
Returns void

setDiscardHandler

setDiscardHandler(discardHandler): void
Sets an object to be called back when a discard is received for the current subject
Parameters
- discardHandler: RecordDiscardHandler
  
  a RecordDiscardHandler object to receive the onDiscard callback
Returns void

Generated using TypeDoc