Update conversation_state.py
Added reference documentation.
@@ -9,19 +9,18 @@ from .storage import Storage
class ConversationState(BotState):
"""Conversation state
Defines a state management object for conversation state.
- Extends `BootState` base class.
+ Extends :class:`BootState` base class.
.. remarks::
Conversation state is available in any turn in a specific conversation, regardless of user, such as in a group conversation.
"""
-
no_key_error_message = "ConversationState: channelId and/or conversation missing from context.activity."
def __init__(self, storage: Storage):
- """ Creates a :class:ConversationState instance
- Creates a new instance of the :class:ConversationState class.
+ """ Creates a :class:`ConversationState` instance
+ Creates a new instance of the :class:`ConversationState` class.
:param storage: The storage containing the conversation state.
- :type storage: Storage
+ :type storage: :class:`Storage`
"""
super(ConversationState, self).__init__(storage, "ConversationState")
@@ -30,17 +29,17 @@ class ConversationState(BotState):
Gets the key to use when reading and writing state to and from storage.
:param turn_context: The context object for this turn.
- :type turn_context: TurnContext
+ :type turn_context: :class:`TurnContext`
- :raise: `TypeError` if the `ITurnContext.Activity` for the current turn is missing
- :any::Schema.Activity.ChannelId or :any::Schema.Activity.Conversation information, or
- the conversation's :any::Schema.ConversationAccount.Id is missing.
+ :raise: :class:`TypeError` if the :meth:`TurnContext.activity` for the current turn is missing
+ :class:`botbuilder.schema.Activity` channelId or conversation information or the conversation's
+ account id is missing.
:return: The storage key.
:rtype: str
.. remarks::
- Conversation state includes the channel ID and conversation ID as part of its storage key.
+ Conversation state includes the channel Id and conversation Id as part of its storage key.
"""
channel_id = turn_context.activity.channel_id or self.__raise_type_error(
"invalid activity-missing channel_id"
@@ -56,7 +55,7 @@ class ConversationState(BotState):
return storage_key
def __raise_type_error(self, err: str = "NoneType found while expecting value"):
- """ Raise type error
- :raises: :class:TypeError This function raises exception.
+ """ Raise type error exception
+ :raises: :class:`TypeError`
"""
raise TypeError(err)
