qiskit.providers.ibmq.runtime.UserMessenger

class UserMessenger

Base class for handling communication with program users.

This class can be used when writing a new Qiskit Runtime program.

__init__()

Initialize self. See help(type(self)) for accurate signature.

Methods

__init__()	Initialize self.
publish(message[, encoder, final])	Publish message.

publish(message, encoder=<class 'qiskit.providers.ibmq.runtime.utils.RuntimeEncoder'>, final=False)

Publish message.

You can use this method to publish messages, such as interim and final results, to the program user. The messages will be made immediately available to the user, but they may choose not to receive the messages.

The final parameter is used to indicate whether the message is the final result of the program. Final results may be processed differently from interim results.

パラメータ

• message (Any) – Message to be published. Can be any type.

• encoder (Type[JSONEncoder]) – An optional JSON encoder for serializing

• final (bool) – Whether the message being published is the final result.

戻り値の型

None