Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions SP-Framework/sp-adaptive-card-extension-base.yml
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,6 @@ typeAliases:
- '@microsoft/sp-adaptive-card-extension-base!DeviceContext:type'
- '@microsoft/sp-adaptive-card-extension-base!GenericCardViewFooterConfiguration:type'
- '@microsoft/sp-adaptive-card-extension-base!GenericCardViewFooterParameters:type'
- '@microsoft/sp-adaptive-card-extension-base!HostTheme:type'
- '@microsoft/sp-adaptive-card-extension-base!IActionArguments:type'
- '@microsoft/sp-adaptive-card-extension-base!IActionErrorArguments:type'
- '@microsoft/sp-adaptive-card-extension-base!IAdaptiveCardExtensionIcon:type'
Expand Down Expand Up @@ -85,13 +84,16 @@ interfaces:
- '@microsoft/sp-adaptive-card-extension-base!IGetLocationActionArguments:interface'
- '@microsoft/sp-adaptive-card-extension-base!IGetLocationActionParameters:interface'
- '@microsoft/sp-adaptive-card-extension-base!IGetLocationCardAction:interface'
- '@microsoft/sp-adaptive-card-extension-base!IHostContext:interface'
- '@microsoft/sp-adaptive-card-extension-base!IImageCardParameters:interface'
- '@microsoft/sp-adaptive-card-extension-base!IImageCardViewConfiguration:interface'
- '@microsoft/sp-adaptive-card-extension-base!ILocation:interface'
- '@microsoft/sp-adaptive-card-extension-base!ILocationErrorArguments:interface'
- '@microsoft/sp-adaptive-card-extension-base!INotificationArguments:interface'
- '@microsoft/sp-adaptive-card-extension-base!INotificationResponse:interface'
- '@microsoft/sp-adaptive-card-extension-base!IPartialMicrosoftTeams:interface'
- '@microsoft/sp-adaptive-card-extension-base!IPartialSDKs:interface'
- '@microsoft/sp-adaptive-card-extension-base!IPartialTeamsContext:interface'
- '@microsoft/sp-adaptive-card-extension-base!IPartialTeamsJs:interface'
- '@microsoft/sp-adaptive-card-extension-base!IPrimaryTextCardParameters:interface'
- '@microsoft/sp-adaptive-card-extension-base!IPrimaryTextCardViewConfiguration:interface'
- '@microsoft/sp-adaptive-card-extension-base!IQuickViewActionArguments:interface'
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,18 +23,6 @@ properties:
content: 'get deviceContext(): DeviceContext;'
return:
type: '<xref uid="@microsoft/sp-adaptive-card-extension-base!DeviceContext:type" />'
- name: hostContext
uid: '@microsoft/sp-adaptive-card-extension-base!AdaptiveCardExtensionContext#hostContext:member'
package: '@microsoft/sp-adaptive-card-extension-base!'
fullName: hostContext
summary: Provides a hostContext that gets current context of device
remarks: ''
isPreview: true
isDeprecated: false
syntax:
content: 'get hostContext(): IHostContext | undefined;'
return:
type: '<xref uid="@microsoft/sp-adaptive-card-extension-base!IHostContext:interface" /> | undefined'
- name: location
uid: '@microsoft/sp-adaptive-card-extension-base!AdaptiveCardExtensionContext#location:member'
package: '@microsoft/sp-adaptive-card-extension-base!'
Expand Down Expand Up @@ -71,4 +59,18 @@ properties:
content: 'get propertyPane(): IPropertyPaneAccessor | undefined;'
return:
type: '<xref uid="@microsoft/sp-webpart-base!IPropertyPaneAccessor:interface" /> | undefined'
- name: sdks
uid: '@microsoft/sp-adaptive-card-extension-base!AdaptiveCardExtensionContext#sdks:member'
package: '@microsoft/sp-adaptive-card-extension-base!'
fullName: sdks
summary: >-
Provides a sdk that gets current context of device. See
[IPartialSDKs](xref:@microsoft/sp-adaptive-card-extension-base!IPartialSDKs:interface)
remarks: ''
isPreview: true
isDeprecated: false
syntax:
content: 'get sdks(): IPartialSDKs | undefined;'
return:
type: '<xref uid="@microsoft/sp-adaptive-card-extension-base!IPartialSDKs:interface" /> | undefined'
extends: '<xref uid="@microsoft/sp-component-base!BaseComponentContext:class" />'
10 changes: 0 additions & 10 deletions SP-Framework/sp-adaptive-card-extension-base/hosttheme.yml

This file was deleted.

26 changes: 0 additions & 26 deletions SP-Framework/sp-adaptive-card-extension-base/ihostcontext.yml

This file was deleted.

Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
### YamlMime:TSType
name: IPartialMicrosoftTeams
uid: '@microsoft/sp-adaptive-card-extension-base!IPartialMicrosoftTeams:interface'
package: '@microsoft/sp-adaptive-card-extension-base!'
fullName: IPartialMicrosoftTeams
summary: |-
Provides access to the Teams SDK and Teams context. Only provided when the web part is loaded in Teams.

Currently We are providing only Partial Contextual Information.
remarks: ''
isPreview: true
isDeprecated: false
type: interface
properties:
- name: teamsJs
uid: '@microsoft/sp-adaptive-card-extension-base!IPartialMicrosoftTeams#teamsJs:member'
package: '@microsoft/sp-adaptive-card-extension-base!'
fullName: teamsJs
summary: Partial Microsoft Teams SDK.
remarks: ''
isPreview: true
isDeprecated: false
syntax:
content: 'teamsJs: IPartialTeamsJs;'
return:
type: '<xref uid="@microsoft/sp-adaptive-card-extension-base!IPartialTeamsJs:interface" />'
33 changes: 33 additions & 0 deletions SP-Framework/sp-adaptive-card-extension-base/ipartialsdks.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
### YamlMime:TSType
name: IPartialSDKs
uid: '@microsoft/sp-adaptive-card-extension-base!IPartialSDKs:interface'
package: '@microsoft/sp-adaptive-card-extension-base!'
fullName: IPartialSDKs
summary: |-
Conditional set of SDKs provided by SPFx dependent on the environment.

Currently we are providing only Partial SDKs.
remarks: ''
isPreview: true
isDeprecated: false
type: interface
properties:
- name: microsoftTeams
uid: '@microsoft/sp-adaptive-card-extension-base!IPartialSDKs#microsoftTeams:member'
package: '@microsoft/sp-adaptive-card-extension-base!'
fullName: microsoftTeams
summary: >-
Contextual information about the current Microsoft Teams tab. This object will only be defined if a component is
being hosted in Microsoft Teams.
remarks: >-
For more information, please see:
[https://docs.microsoft.com/en-us/javascript/api/@microsoft/teams-js/?view=msteams-client-js-latest](https://docs.microsoft.com/en-us/javascript/api/@microsoft/teams-js/?view=msteams-client-js-latest)


Currently We are providing only Partial Contextual Information.
isPreview: true
isDeprecated: false
syntax:
content: 'microsoftTeams?: IPartialMicrosoftTeams;'
return:
type: '<xref uid="@microsoft/sp-adaptive-card-extension-base!IPartialMicrosoftTeams:interface" />'
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
### YamlMime:TSType
name: IPartialTeamsContext
uid: '@microsoft/sp-adaptive-card-extension-base!IPartialTeamsContext:interface'
package: '@microsoft/sp-adaptive-card-extension-base!'
fullName: IPartialTeamsContext
summary: Partial teams context
remarks: ''
isPreview: true
isDeprecated: false
type: interface
properties:
- name: app
uid: '@microsoft/sp-adaptive-card-extension-base!IPartialTeamsContext#app:member'
package: '@microsoft/sp-adaptive-card-extension-base!'
fullName: app
summary: Properties about the current session for your app
remarks: ''
isPreview: true
isDeprecated: false
syntax:
content: |-
app: {
appInfo: Pick<microsoftTeams.app.AppInfo, 'theme'>;
};
return:
type: |-
{
appInfo: Pick&lt;<xref uid="@microsoft/teams-js!app.AppInfo:interface" />, 'theme'&gt;;
}
29 changes: 29 additions & 0 deletions SP-Framework/sp-adaptive-card-extension-base/ipartialteamsjs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
### YamlMime:TSType
name: IPartialTeamsJs
uid: '@microsoft/sp-adaptive-card-extension-base!IPartialTeamsJs:interface'
package: '@microsoft/sp-adaptive-card-extension-base!'
fullName: IPartialTeamsJs
summary: Provides access to the Teams SDK and Teams context. Only provided when the web part is loaded in Teams.
remarks: ''
isPreview: true
isDeprecated: false
type: interface
properties:
- name: app
uid: '@microsoft/sp-adaptive-card-extension-base!IPartialTeamsJs#app:member'
package: '@microsoft/sp-adaptive-card-extension-base!'
fullName: app
summary: Namespace to interact with Teams app initialization and lifecycle.
remarks: Currently we are providing only partial contextual information of Teams app.
isPreview: true
isDeprecated: false
syntax:
content: |-
app: {
getContext: () => Promise<IPartialTeamsContext>;
};
return:
type: |-
{
getContext: () =&gt; Promise&lt;<xref uid="@microsoft/sp-adaptive-card-extension-base!IPartialTeamsContext:interface" />&gt;;
}
12 changes: 12 additions & 0 deletions SP-Framework/sp-image-helper/iimagehelperrequest.yml
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,18 @@ properties:
content: 'sourceUrl: string;'
return:
type: string
- name: version
uid: '@microsoft/sp-image-helper!IImageHelperRequest#version:member'
package: '@microsoft/sp-image-helper!'
fullName: version
summary: guid generated for image version to use as param to avoid caching from api on adv edited images
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'version?: string;'
return:
type: string
- name: width
uid: '@microsoft/sp-image-helper!IImageHelperRequest#width:member'
package: '@microsoft/sp-image-helper!'
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,30 +9,6 @@ isPreview: true
isDeprecated: false
type: interface
properties:
- name: connectedSPFXAppId
uid: '@microsoft/sp-module-interfaces!IAdaptiveCardExtensionManifest#connectedSPFXAppId:member'
package: '@microsoft/sp-module-interfaces!'
fullName: connectedSPFXAppId
summary: Id of the SPFx application that the ACE will redirect to when a “full page” experience is required
remarks: ''
isPreview: true
isDeprecated: false
syntax:
content: 'connectedSPFXAppId?: string;'
return:
type: string
- name: connectedTeamsAppId
uid: '@microsoft/sp-module-interfaces!IAdaptiveCardExtensionManifest#connectedTeamsAppId:member'
package: '@microsoft/sp-module-interfaces!'
fullName: connectedTeamsAppId
summary: Id matching the Teams SaaS application that the ACE will redirect to when a “full page” experience is required
remarks: ''
isPreview: true
isDeprecated: false
syntax:
content: 'connectedTeamsAppId?: string;'
return:
type: string
- name: experimentalData
uid: '@microsoft/sp-module-interfaces!IAdaptiveCardExtensionManifest#experimentalData:member'
package: '@microsoft/sp-module-interfaces!'
Expand Down
12 changes: 8 additions & 4 deletions SP-Framework/toc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -55,8 +55,6 @@ items:
uid: '@microsoft/sp-adaptive-card-extension-base!GenericCardViewFooterConfiguration:type'
- name: GenericCardViewFooterParameters
uid: '@microsoft/sp-adaptive-card-extension-base!GenericCardViewFooterParameters:type'
- name: HostTheme
uid: '@microsoft/sp-adaptive-card-extension-base!HostTheme:type'
- name: IActionArguments
uid: '@microsoft/sp-adaptive-card-extension-base!IActionArguments:type'
- name: IActionError
Expand Down Expand Up @@ -157,8 +155,6 @@ items:
uid: '@microsoft/sp-adaptive-card-extension-base!IGetLocationActionParameters:interface'
- name: IGetLocationCardAction
uid: '@microsoft/sp-adaptive-card-extension-base!IGetLocationCardAction:interface'
- name: IHostContext
uid: '@microsoft/sp-adaptive-card-extension-base!IHostContext:interface'
- name: IImageCardParameters
uid: '@microsoft/sp-adaptive-card-extension-base!IImageCardParameters:interface'
- name: IImageCardViewConfiguration
Expand All @@ -173,6 +169,14 @@ items:
uid: '@microsoft/sp-adaptive-card-extension-base!INotificationResponse:interface'
- name: IOnBeforeActionArguments
uid: '@microsoft/sp-adaptive-card-extension-base!IOnBeforeActionArguments:type'
- name: IPartialMicrosoftTeams
uid: '@microsoft/sp-adaptive-card-extension-base!IPartialMicrosoftTeams:interface'
- name: IPartialSDKs
uid: '@microsoft/sp-adaptive-card-extension-base!IPartialSDKs:interface'
- name: IPartialTeamsContext
uid: '@microsoft/sp-adaptive-card-extension-base!IPartialTeamsContext:interface'
- name: IPartialTeamsJs
uid: '@microsoft/sp-adaptive-card-extension-base!IPartialTeamsJs:interface'
- name: IPrimaryTextCardParameters
uid: '@microsoft/sp-adaptive-card-extension-base!IPrimaryTextCardParameters:interface'
- name: IPrimaryTextCardViewConfiguration
Expand Down