TeamsInfo Class

Package:
com.microsoft.bot.builder.teams
Maven Artifact:
com.microsoft.bot:bot-builder:4.14.3
  • java.lang.Object
    • com.microsoft.bot.builder.teams.TeamsInfo

public final class TeamsInfo

Teams helper methods.

Method Summary

Modifier and Type Method and Description
static java.util.concurrent.CompletableFuture<MeetingInfo> getMeetingInfo(TurnContext turnContext)

Gets the information for the given meeting id.
static java.util.concurrent.CompletableFuture<MeetingInfo> getMeetingInfo(TurnContext turnContext, String meetingId)

Gets the information for the given meeting id.
static java.util.concurrent.CompletableFuture<TeamsMeetingParticipant> getMeetingParticipant(TurnContext turnContext)

Gets the details for the given meeting participant.
static java.util.concurrent.CompletableFuture<TeamsMeetingParticipant> getMeetingParticipant(TurnContext turnContext, String meetingId, String participantId, String tenantId)

Gets the details for the given meeting participant.
static java.util.concurrent.CompletableFuture<TeamsChannelAccount> getMember(TurnContext turnContext, String userId)
static java.util.concurrent.CompletableFuture<java.util.List<TeamsChannelAccount>> getMembers(TurnContext turnContext)

Returns a list of members for the current conversation.
static java.util.concurrent.CompletableFuture<TeamsPagedMembersResult> getPagedMembers(TurnContext turnContext, String continuationToken)

Returns paged Team member list.
static java.util.concurrent.CompletableFuture<TeamsPagedMembersResult> getPagedTeamMembers(TurnContext turnContext, String teamId, String continuationToken)

Returns paged Team member list.
static java.util.concurrent.CompletableFuture<java.util.List<ChannelInfo>> getTeamChannels(TurnContext turnContext, String teamId)

Returns a list of Teams channels.
static java.util.concurrent.CompletableFuture<TeamDetails> getTeamDetails(TurnContext turnContext, String teamId)

Returns TeamDetails for a Team.
static java.util.concurrent.CompletableFuture<TeamsChannelAccount> getTeamMember(TurnContext turnContext, String userId, String teamId)

Returns info for the specified user.
static java.util.concurrent.CompletableFuture<java.util.List<TeamsChannelAccount>> getTeamMembers(TurnContext turnContext, String teamId)

Returns a list of team members for the specified team.
static java.util.concurrent.CompletableFuture<Pair<ConversationReference,java.lang.String>> sendMessageToTeamsChannel(TurnContext turnContext, Activity activity, String teamsChannelId, MicrosoftAppCredentials credentials)

Methods inherited from java.lang.Object

java.lang.Object.clone java.lang.Object.equals java.lang.Object.finalize java.lang.Object.getClass java.lang.Object.hashCode java.lang.Object.notify java.lang.Object.notifyAll java.lang.Object.toString java.lang.Object.wait java.lang.Object.wait java.lang.Object.wait

Method Details

getMeetingInfo

public static CompletableFuture getMeetingInfo(TurnContext turnContext)

Gets the information for the given meeting id.

Parameters:

turnContext - Turn context.

Returns:

Meeting Details.

getMeetingInfo

public static CompletableFuture getMeetingInfo(TurnContext turnContext, String meetingId)

Gets the information for the given meeting id.

Parameters:

turnContext - Turn context.
meetingId - The BASE64-encoded id of the Teams meeting.

Returns:

Meeting Details.

getMeetingParticipant

public static CompletableFuture getMeetingParticipant(TurnContext turnContext)

Gets the details for the given meeting participant. This only works in teams meeting scoped conversations.

Parameters:

turnContext - The TurnContext that the meeting, participant, and tenant ids are pulled from.

Returns:

TeamsParticipantChannelAccount

getMeetingParticipant

public static CompletableFuture getMeetingParticipant(TurnContext turnContext, String meetingId, String participantId, String tenantId)

Gets the details for the given meeting participant. This only works in teams meeting scoped conversations.

Parameters:

turnContext - Turn context.
meetingId - The meeting id, or null to get from Activities TeamsChannelData
participantId - The participant id, or null to get from Activities TeamsChannelData
tenantId - The tenant id, or null to get from Activities TeamsChannelData

Returns:

Team participant channel account.

getMember

public static CompletableFuture getMember(TurnContext turnContext, String userId)

Parameters:

turnContext
userId

getMembers

public static CompletableFuture> getMembers(TurnContext turnContext)

Returns a list of members for the current conversation.

Parameters:

turnContext - The current TurnContext.

Returns:

A list of TeamsChannelAccount for each member. If this isn't a Teams conversation, a list of ChannelAccounts is converted to TeamsChannelAccount.

getPagedMembers

public static CompletableFuture getPagedMembers(TurnContext turnContext, String continuationToken)

Returns paged Team member list. If the Activity is not from a Teams channel, a PagedMembersResult is converted to TeamsPagedMembersResult.

Parameters:

turnContext - The current TurnContext.
continuationToken - The continuationToken from a previous call, or null the first call.

Returns:

A TeamsPageMembersResult.

getPagedTeamMembers

public static CompletableFuture getPagedTeamMembers(TurnContext turnContext, String teamId, String continuationToken)

Returns paged Team member list.

Parameters:

turnContext - The current TurnContext.
teamId - The team id.
continuationToken - The continuationToken from a previous call, or null the first call.

Returns:

A TeamsPageMembersResult.

getTeamChannels

public static CompletableFuture> getTeamChannels(TurnContext turnContext, String teamId)

Returns a list of Teams channels.

Parameters:

turnContext - The current TurnContext.
teamId - The team id.

Returns:

A list of ChannelInfo objects.

getTeamDetails

public static CompletableFuture getTeamDetails(TurnContext turnContext, String teamId)

Returns TeamDetails for a Team.

Parameters:

turnContext - The current TurnContext.
teamId - The team id.

Returns:

A TeamDetails object.

getTeamMember

public static CompletableFuture getTeamMember(TurnContext turnContext, String userId, String teamId)

Returns info for the specified user.

Parameters:

turnContext - The current TurnContext.
userId - The user id.
teamId - The team id for the user.

Returns:

A TeamsChannelAccount for the user, or null if not found.

getTeamMembers

public static CompletableFuture> getTeamMembers(TurnContext turnContext, String teamId)

Returns a list of team members for the specified team.

Parameters:

turnContext - The current TurnContext.
teamId - The team id.

Returns:

A list of TeamChannelAccount objects.

sendMessageToTeamsChannel

public static CompletableFuture> sendMessageToTeamsChannel(TurnContext turnContext, Activity activity, String teamsChannelId, MicrosoftAppCredentials credentials)

Parameters:

turnContext
activity
teamsChannelId
credentials

Applies to