ComUsersMicrosoftGraphComponent class

Package:

@microsoft/teams.cards

Displays multiple users' information, including their profile pictures.

Constructors

ComUsersMicrosoftGraphComponent(ComUsersMicrosoftGraphComponentOptions)

Properties

fallback	An alternate element to render if the type of this one is unsupported or if the host application doesn't support all the capabilities specified in the requires property.
grid.area	The area of a Layout.AreaGrid layout in which an element should be displayed.
height	The height of the element. When set to stretch, the element will use the remaining vertical space in its container.
horizontalAlignment	Controls how the element should be horizontally aligned.
id	A unique identifier for the element or action. Input elements must have an id, otherwise they will not be validated and their values will not be sent to the Bot.
isSortKey	Controls whether the element should be used as a sort key by elements that allow sorting across a collection of elements.
isVisible	Controls the visibility of the element.
lang	The locale associated with the element.
name	Must be graph.microsoft.com/users.
properties	The properties of the set.
requires	A list of capabilities the element requires the host application to support. If the host application doesn't support at least one of the listed capabilities, the element is not rendered (or its fallback is rendered if provided).
separator	Controls whether a separator line should be displayed above the element to visually separate it from the previous element. No separator will be displayed for the first element in a container, even if this property is set to true.
spacing	Controls the amount of space between this element and the previous one. No space will be added for the first element in a container.
targetWidth	Controls for which card width the element should be displayed. If targetWidth isn't specified, the element is rendered at all card widths. Using targetWidth makes it possible to author responsive cards that adapt their layout to the available horizontal space. For more details, see Responsive layout.
type	Must be Component.

Methods

from(Omit<IComUsersMicrosoftGraphComponent, "type" | "name">)
withFallback(FallbackElement)
withHeight(ElementHeight)
withHorizontalAlignment(HorizontalAlignment)
withId(string)
withIsSortKey(boolean)
withIsVisible(boolean)
withLang(string)
withProperties(IPersonaSetProperties)
withRequires(IHostCapabilities)
withSeparator(boolean)
withSpacing(Spacing)
withTargetWidth(TargetWidth)

Constructor Details

ComUsersMicrosoftGraphComponent(ComUsersMicrosoftGraphComponentOptions)

new ComUsersMicrosoftGraphComponent(options?: ComUsersMicrosoftGraphComponentOptions)

Parameters

options

ComUsersMicrosoftGraphComponentOptions

Property Details

fallback

An alternate element to render if the type of this one is unsupported or if the host application doesn't support all the capabilities specified in the requires property.

fallback?: FallbackElement

Property Value

FallbackElement

grid.area

The area of a Layout.AreaGrid layout in which an element should be displayed.

grid.area?: string

Property Value

string

height

The height of the element. When set to stretch, the element will use the remaining vertical space in its container.

height?: ElementHeight

Property Value

ElementHeight

horizontalAlignment

Controls how the element should be horizontally aligned.

horizontalAlignment?: HorizontalAlignment

Property Value

HorizontalAlignment

id

A unique identifier for the element or action. Input elements must have an id, otherwise they will not be validated and their values will not be sent to the Bot.

id?: string

Property Value

string

isSortKey

Controls whether the element should be used as a sort key by elements that allow sorting across a collection of elements.

isSortKey?: boolean

Property Value

boolean

isVisible

Controls the visibility of the element.

isVisible?: boolean

Property Value

boolean

lang

The locale associated with the element.

lang?: string

Property Value

string

name

Must be graph.microsoft.com/users.

name: "graph.microsoft.com/users" = "graph.microsoft.com/users"

Property Value

"graph.microsoft.com/users"

properties

The properties of the set.

properties?: IPersonaSetProperties

Property Value

IPersonaSetProperties

requires

A list of capabilities the element requires the host application to support. If the host application doesn't support at least one of the listed capabilities, the element is not rendered (or its fallback is rendered if provided).

requires?: IHostCapabilities

Property Value

IHostCapabilities

separator

Controls whether a separator line should be displayed above the element to visually separate it from the previous element. No separator will be displayed for the first element in a container, even if this property is set to true.

separator?: boolean

Property Value

boolean

spacing

Controls the amount of space between this element and the previous one. No space will be added for the first element in a container.

spacing?: Spacing

Property Value

Spacing

targetWidth

Controls for which card width the element should be displayed. If targetWidth isn't specified, the element is rendered at all card widths. Using targetWidth makes it possible to author responsive cards that adapt their layout to the available horizontal space. For more details, see Responsive layout.

targetWidth?: TargetWidth

Property Value

TargetWidth

type

Must be Component.

type: "Component" = "Component"

Property Value

"Component"

Method Details

from(Omit<IComUsersMicrosoftGraphComponent, "type" | "name">)

static function from(options: Omit<IComUsersMicrosoftGraphComponent, "type" | "name">): ComUsersMicrosoftGraphComponent

Parameters

options

Omit<IComUsersMicrosoftGraphComponent, "type" | "name">

Returns

ComUsersMicrosoftGraphComponent

withFallback(FallbackElement)

function withFallback(fallback: FallbackElement): ComUsersMicrosoftGraphComponent

Parameters

fallback

FallbackElement

Returns

ComUsersMicrosoftGraphComponent

withHeight(ElementHeight)

function withHeight(height: ElementHeight): ComUsersMicrosoftGraphComponent

Parameters

height

ElementHeight

Returns

ComUsersMicrosoftGraphComponent

withHorizontalAlignment(HorizontalAlignment)

function withHorizontalAlignment(horizontalAlignment: HorizontalAlignment): ComUsersMicrosoftGraphComponent

Parameters

horizontalAlignment

HorizontalAlignment

Returns

ComUsersMicrosoftGraphComponent

withId(string)

function withId(id: string): ComUsersMicrosoftGraphComponent

Parameters

id

string

Returns

ComUsersMicrosoftGraphComponent

withIsSortKey(boolean)

function withIsSortKey(isSortKey?: boolean): ComUsersMicrosoftGraphComponent

Parameters

isSortKey

boolean

Returns

ComUsersMicrosoftGraphComponent

withIsVisible(boolean)

function withIsVisible(isVisible?: boolean): ComUsersMicrosoftGraphComponent

Parameters

isVisible

boolean

Returns

ComUsersMicrosoftGraphComponent

withLang(string)

function withLang(lang: string): ComUsersMicrosoftGraphComponent

Parameters

lang

string

Returns

ComUsersMicrosoftGraphComponent

withProperties(IPersonaSetProperties)

function withProperties(properties: IPersonaSetProperties): ComUsersMicrosoftGraphComponent

Parameters

properties

IPersonaSetProperties

Returns

ComUsersMicrosoftGraphComponent

withRequires(IHostCapabilities)

function withRequires(requires: IHostCapabilities): ComUsersMicrosoftGraphComponent

Parameters

requires

IHostCapabilities

Returns

ComUsersMicrosoftGraphComponent

withSeparator(boolean)

function withSeparator(separator?: boolean): ComUsersMicrosoftGraphComponent

Parameters

separator

boolean

Returns

ComUsersMicrosoftGraphComponent

withSpacing(Spacing)

function withSpacing(spacing: Spacing): ComUsersMicrosoftGraphComponent

Parameters

spacing

Spacing

Returns

ComUsersMicrosoftGraphComponent

withTargetWidth(TargetWidth)

function withTargetWidth(targetWidth: TargetWidth): ComUsersMicrosoftGraphComponent

Parameters

targetWidth

TargetWidth

Returns

ComUsersMicrosoftGraphComponent