Microsoft365PublishDefaults Class

  • java.lang.Object
    • com.azure.ai.agents.models.Microsoft365PublishDefaults

Implements

public final class Microsoft365PublishDefaults
implements JsonSerializable<Microsoft365PublishDefaults>

Default and previously-published values used to pre-populate a Microsoft 365 publish request for a Foundry agent.

Method Summary

Modifier and Type Method and Description
static Microsoft365PublishDefaults fromJson(JsonReader jsonReader)

Reads an instance of Microsoft365PublishDefaults from the JsonReader.

String getAgentDisplayName()

Get the agentDisplayName property: The user-facing display name for the agent.

String getAgentName()

Get the agentName property: The agent name.

Microsoft365PublishScope getAppPublishScope()

Get the appPublishScope property: The publish scope.

String getAppRegistrationClientId()

Get the appRegistrationClientId property: The app-registration client id associated with the agent.

String getAppVersion()

Get the appVersion property: The most recently published app version.

String getBotServiceArmId()

Get the botServiceArmId property: ARM resource id of the Azure Bot Service associated with the previously-published app, if any.

String getDeveloperName()

Get the developerName property: Display name of the developer / publisher.

String getDeveloperWebsiteUrl()

Get the developerWebsiteUrl property: Developer / publisher website URL.

String getFullDescription()

Get the fullDescription property: Full description shown on the Teams app details page.

String getPrivacyUrl()

Get the privacyUrl property: Privacy policy URL.

String getRecommendedNextAppVersion()

Get the recommendedNextAppVersion property: The recommended next app version (the most recent app version, incremented).

String getShortDescription()

Get the shortDescription property: Short, one-line description shown in the Teams app listing.

String getTeamsAppId()

Get the teamsAppId property: The Microsoft Teams app id of the previously-published app, if any.

String getTermsOfUseUrl()

Get the termsOfUseUrl property: Terms-of-use URL.

String getTitleId()

Get the titleId property: The Microsoft 365 title id of the previously-published app, if any.

JsonWriter toJson(JsonWriter jsonWriter)

Methods inherited from java.lang.Object

Method Details

fromJson

public static Microsoft365PublishDefaults fromJson(JsonReader jsonReader)

Reads an instance of Microsoft365PublishDefaults from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of Microsoft365PublishDefaults if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.

Throws:

IOException

- If an error occurs while reading the Microsoft365PublishDefaults.

getAgentDisplayName

public String getAgentDisplayName()

Get the agentDisplayName property: The user-facing display name for the agent. Defaults to the agent name if not previously overridden.

Returns:

the agentDisplayName value.

getAgentName

public String getAgentName()

Get the agentName property: The agent name.

Returns:

the agentName value.

getAppPublishScope

public Microsoft365PublishScope getAppPublishScope()

Get the appPublishScope property: The publish scope.

Returns:

the appPublishScope value.

getAppRegistrationClientId

public String getAppRegistrationClientId()

Get the appRegistrationClientId property: The app-registration client id associated with the agent.

Returns:

the appRegistrationClientId value.

getAppVersion

public String getAppVersion()

Get the appVersion property: The most recently published app version.

Returns:

the appVersion value.

getBotServiceArmId

public String getBotServiceArmId()

Get the botServiceArmId property: ARM resource id of the Azure Bot Service associated with the previously-published app, if any.

Returns:

the botServiceArmId value.

getDeveloperName

public String getDeveloperName()

Get the developerName property: Display name of the developer / publisher.

Returns:

the developerName value.

getDeveloperWebsiteUrl

public String getDeveloperWebsiteUrl()

Get the developerWebsiteUrl property: Developer / publisher website URL.

Returns:

the developerWebsiteUrl value.

getFullDescription

public String getFullDescription()

Get the fullDescription property: Full description shown on the Teams app details page.

Returns:

the fullDescription value.

getPrivacyUrl

public String getPrivacyUrl()

Get the privacyUrl property: Privacy policy URL.

Returns:

the privacyUrl value.

getRecommendedNextAppVersion

public String getRecommendedNextAppVersion()

Get the recommendedNextAppVersion property: The recommended next app version (the most recent app version, incremented).

Returns:

the recommendedNextAppVersion value.

getShortDescription

public String getShortDescription()

Get the shortDescription property: Short, one-line description shown in the Teams app listing.

Returns:

the shortDescription value.

getTeamsAppId

public String getTeamsAppId()

Get the teamsAppId property: The Microsoft Teams app id of the previously-published app, if any.

Returns:

the teamsAppId value.

getTermsOfUseUrl

public String getTermsOfUseUrl()

Get the termsOfUseUrl property: Terms-of-use URL.

Returns:

the termsOfUseUrl value.

getTitleId

public String getTitleId()

Get the titleId property: The Microsoft 365 title id of the previously-published app, if any.

Returns:

the titleId value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

Applies to