@@ -87,11 +87,9 @@ def __init__(
8787 """
8888 Contains the settings used to initialize a :class:`BotFrameworkAdapter` instance.
8989
90- :param app_id: The bot application ID. This is the appId returned by the Azure portal registration, and is
91- the value of the `MicrosoftAppId` parameter in the `config.py` file.
90+ :param app_id: The bot application ID.
9291 :type app_id: str
93- :param app_password: The bot application password. This is the password returned by the Azure portal
94- registration, and is
92+ :param app_password: The bot application password.
9593 the value os the `MicrosoftAppPassword` parameter in the `config.py` file.
9694 :type app_password: str
9795 :param channel_auth_tenant: The channel tenant to use in conversation
@@ -201,7 +199,7 @@ async def continue_conversation(
201199
202200 :return: A task that represents the work queued to execute.
203201
204- .. note ::
202+ .. remarks ::
205203 This is often referred to as the bots *proactive messaging* flow as it lets the bot proactively
206204 send messages to a conversation or user that are already in a communication.
207205 Scenarios such as sending notifications or coupons to a user are enabled by this function.
@@ -247,7 +245,7 @@ async def create_conversation(
247245
248246 :return: A task representing the work queued to execute.
249247
250- .. note ::
248+ .. remarks ::
251249 To start a conversation, your bot must know its account information and the user's
252250 account information on that channel.
253251 Most channels only support initiating a direct message (non-group) conversation.
@@ -306,9 +304,7 @@ async def create_conversation(
306304
307305 async def process_activity (self , req , auth_header : str , logic : Callable ):
308306 """
309- Creates a turn context and runs the middleware pipeline for an incoming activity,
310- Processes an activity received by the bots web server. This includes any messages sent from a
311- user and is the method that drives what's often referred to as the bots *reactive messaging* flow.
307+ Creates a turn context and runs the middleware pipeline for an incoming activity.
312308
313309 :param req: The incoming activity
314310 :type req: :class:`typing.str`
@@ -317,15 +313,15 @@ async def process_activity(self, req, auth_header: str, logic: Callable):
317313 :param logic: The logic to execute at the end of the adapter's middleware pipeline.
318314 :type logic: :class:`typing.Callable`
319315
320- :return: A task that represents the work queued to execute. If the activity type
321- was `Invoke` and the corresponding key (`channelId` + `activityId`) was found then
322- an :class:`InvokeResponse` is returned; otherwise, `null` is returned.
316+ :return: A task that represents the work queued to execute.
323317
324- .. note::
318+ .. remarks::
319+ This class processes an activity received by the bots web server. This includes any messages
320+ sent from a user and is the method that drives what's often referred to as the
321+ bots *reactive messaging* flow.
325322 Call this method to reactively send a message to a conversation.
326323 If the task completes successfully, then an :class:`InvokeResponse` is returned;
327324 otherwise. `null` is returned.
328-
329325 """
330326 activity = await self .parse_request (req )
331327 auth_header = auth_header or ""
@@ -457,7 +453,7 @@ async def update_activity(self, context: TurnContext, activity: Activity):
457453
458454 :return: A task that represents the work queued to execute
459455
460- .. note ::
456+ .. remarks ::
461457 If the activity is successfully sent, the task result contains
462458 a :class:`botbuilder.schema.ResourceResponse` object containing the ID that
463459 the receiving channel assigned to the activity.
@@ -490,6 +486,7 @@ async def delete_activity(
490486 :return: A task that represents the work queued to execute
491487
492488 .. note::
489+
493490 The activity_id of the :class:`botbuilder.schema.ConversationReference` identifies the activity to delete.
494491 """
495492 try :
@@ -565,7 +562,7 @@ async def delete_conversation_member(
565562 Deletes a member from the current conversation.
566563
567564 :param context: The context object for the turn
568- :type context: :class:`TurnContext`
565+ :type context: :class:`botbuilder.core. TurnContext`
569566 :param member_id: The ID of the member to remove from the conversation
570567 :type member_id: str
571568
@@ -603,7 +600,7 @@ async def get_activity_members(self, context: TurnContext, activity_id: str):
603600 Lists the members of a given activity.
604601
605602 :param context: The context object for the turn
606- :type context: :class:`TurnContext`
603+ :type context: :class:`botbuilder.core. TurnContext`
607604 :param activity_id: (Optional) Activity ID to enumerate.
608605 If not specified the current activities ID will be used.
609606
@@ -645,7 +642,7 @@ async def get_conversation_members(self, context: TurnContext):
645642 Lists the members of a current conversation.
646643
647644 :param context: The context object for the turn
648- :type context: :class:`TurnContext`
645+ :type context: :class:`botbuilder.core. TurnContext`
649646
650647 :raises: An exception error
651648
@@ -674,9 +671,7 @@ async def get_conversation_members(self, context: TurnContext):
674671
675672 async def get_conversations (self , service_url : str , continuation_token : str = None ):
676673 """
677- Lists the Conversations in which this bot has participated for a given channel server. The channel server
678- returns results in pages and each page will include a `continuationToken` that can be used to fetch the next
679- page of results from the server.
674+ Lists the Conversations in which this bot has participated for a given channel server.
680675
681676 :param service_url: The URL of the channel server to query. This can be retrieved from
682677 `context.activity.serviceUrl`
@@ -689,8 +684,10 @@ async def get_conversations(self, service_url: str, continuation_token: str = No
689684
690685 :return: A task that represents the work queued to execute
691686
692- .. note:: If the task completes successfully, the result contains a page of the members of the current
693- conversation.
687+ .. remarks::
688+ The channel server returns results in pages and each page will include a `continuationToken` that
689+ can be used to fetch the next page of results from the server.
690+ If the task completes successfully, the result contains a page of the members of the current conversation.
694691 This overload may be called from outside the context of a conversation, as only the bot's service URL and
695692 credentials are required.
696693 """
@@ -705,7 +702,7 @@ async def get_user_token(
705702 Attempts to retrieve the token for a user that's in a login flow.
706703
707704 :param context: Context for the current turn of conversation with the user
708- :type context: :class:`TurnContext`
705+ :type context: :class:`botbuilder.core. TurnContext`
709706 :param connection_name: Name of the auth connection to use
710707 :type connection_name: str
711708 :param magic_code" (Optional) user entered code to validate
@@ -752,7 +749,7 @@ async def sign_out_user(
752749 Signs the user out with the token server.
753750
754751 :param context: Context for the current turn of conversation with the user
755- :type context: :class:`TurnContext`
752+ :type context: :class:`botbuilder.core. TurnContext`
756753 :param connection_name: Name of the auth connection to use
757754 :type connection_name: str
758755 :param user_id: User id of user to sign out
@@ -781,13 +778,14 @@ async def get_oauth_sign_in_link(
781778 Gets the raw sign-in link to be sent to the user for sign-in for a connection name.
782779
783780 :param context: Context for the current turn of conversation with the user
784- :type context: :class:`TurnContext`
781+ :type context: :class:`botbuilder.core. TurnContext`
785782 :param connection_name: Name of the auth connection to use
786783 :type connection_name: str
787784
788785 :returns: A task that represents the work queued to execute
789786
790787 .. note::
788+
791789 If the task completes successfully, the result contains the raw sign-in link
792790 """
793791 self .check_emulating_oauth_cards (context )
@@ -814,7 +812,7 @@ async def get_token_status(
814812 Retrieves the token status for each configured connection for the given user.
815813
816814 :param context: Context for the current turn of conversation with the user
817- :type context: :class:`TurnContext`
815+ :type context: :class:`botbuilder.core. TurnContext`
818816 :param user_id: The user Id for which token status is retrieved
819817 :type user_id: str
820818 :param include_filter: (Optional) Comma separated list of connection's to include.
@@ -848,14 +846,11 @@ async def get_aad_tokens(
848846 Retrieves Azure Active Directory tokens for particular resources on a configured connection.
849847
850848 :param context: Context for the current turn of conversation with the user
851- :type context: :class:`TurnContext`
852-
849+ :type context: :class:`botbuilder.core.TurnContext`
853850 :param connection_name: The name of the Azure Active Directory connection configured with this bot
854851 :type connection_name: str
855-
856852 :param resource_urls: The list of resource URLs to retrieve tokens for
857853 :type resource_urls: :class:`typing.List`
858-
859854 :returns: Dictionary of resource Urls to the corresponding :class:'botbuilder.schema.TokenResponse`
860855 :rtype: :class:`typing.Dict`
861856 """
0 commit comments