Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Irenewang/typedocsupdate #2072

Open
wants to merge 14 commits into
base: main
Choose a base branch
from
Open

Irenewang/typedocsupdate #2072

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
f29e616
Test only add a comment.
irenewangms Nov 17, 2023
5aec58c
Change files
irenewangms Nov 17, 2023
7cbc211
Update actioninfo typedoc.
irenewangms Nov 28, 2023
68e37e6
modify more typedocs around actions
irenewangms Dec 1, 2023
8c38252
delete the change file
irenewangms Dec 1, 2023
2a1831c
Change files
irenewangms Dec 1, 2023
7d798ab
Merge branch 'main' into irenewang/typedocsupdate
irenewang101 Dec 1, 2023
5bc52d8
Remove the test comment.
irenewangms Dec 1, 2023
711baed
Merge branch 'irenewang/typedocsupdate' of https://github.com/OfficeD…
irenewangms Dec 1, 2023
e10ce9c
Update packages/teams-js/src/public/interfaces.ts
irenewang101 Mar 8, 2024
2bd916e
Update change/@microsoft-teams-js-4f7e8cc9-56bd-4cc3-994e-d0dcac0805c…
irenewang101 Mar 8, 2024
ea145ef
Merge branch 'main' into irenewang/typedocsupdate
TrevorJoelHarris Mar 8, 2024
e77291e
Delete package-lock.json
irenewang101 Mar 8, 2024
2a686f4
Merge branch 'main' into irenewang/typedocsupdate
TrevorJoelHarris Apr 30, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
7 changes: 7 additions & 0 deletions change/@microsoft-teams-js-4f7e8cc9-56bd-4cc3-994e-d0dcac0805c5.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"type": "none",
"comment": "Clarified documentation around action interfaces",
"packageName": "@microsoft/teams-js",
"email": "irenewangms@gmail.com",
"dependentChangeType": "none"
}
13 changes: 7 additions & 6 deletions packages/teams-js/src/public/interfaces.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -196,7 +196,7 @@ export enum FileOpenPreference {
}

/**
* Possible Action Types
* Types of Action Objects
*
* @beta
*/
Expand All @@ -218,8 +218,7 @@ export interface BaseActionObject<T extends ActionObjectType> {
}

/**
* Stores information needed to represent M365 Content stored
* in OneDrive or Sharepoint
* Stores information needed to represent content stored in OneDrive or Sharepoint
*
* @beta
*/
Expand All @@ -234,7 +233,7 @@ export interface M365ContentAction extends BaseActionObject<ActionObjectType.M36
}

/**
* Contains information on what Graph item is being queried
* Contains additional IDs of the content that the action is triggered from. Maps to ids used in the Graph.
*
* @beta
*/
Expand Down Expand Up @@ -262,13 +261,15 @@ export enum SecondaryM365ContentIdName {
}

/**
* Information common to all actions
* Information about an Action.
*
* @remarks
* This contains Id of the action, and the information about the object that triggered the action.
* @beta
*/
export interface ActionInfo {
/**
* Maps to the action id supplied inside the manifest
* Id of the action. Maps to the action id supplied inside the manifest
*/
actionId: string;
/**
Expand Down