Codeunit "Microsoft User Feedback"
Codeunit for providing feedback to Microsoft. To be used by internal Microsoft apps only.
Properties
| Name | Value |
|---|---|
| Access | Public |
| InherentPermissions | X |
| InherentEntitlements | X |
Methods
RequestFeedback
Requests general feedback for a feature, optionally specifying if it is a Copilot feature and its area.
procedure RequestFeedback(FeatureName: Text)Parameters
| Name | Type | Description |
|---|---|---|
| FeatureName | Text |
The name of the feature for which feedback is requested. |
RequestFeedback
Requests general feedback for a feature, optionally specifying if it is a Copilot feature and its area.
procedure RequestFeedback(FeatureName: Text, FeatureArea: Text, FeatureAreaDisplayName: Text)Parameters
| Name | Type | Description |
|---|---|---|
| FeatureName | Text |
The name of the feature for which feedback is requested. |
| FeatureArea | Text |
The area or sub-area of the feature. ID on OCV. |
| FeatureAreaDisplayName | Text |
The display name of the feature area. |
RequestFeedback
Requests general feedback for a feature, optionally specifying if it is a Copilot feature and its area.
procedure RequestFeedback(FeatureName: Text, FeatureArea: Text, FeatureAreaDisplayName: Text, ContextFiles: Dictionary of [Text, Text], ContextProperties: Dictionary of [Text, Text])Parameters
| Name | Type | Description |
|---|---|---|
| FeatureName | Text |
The name of the feature for which feedback is requested. |
| FeatureArea | Text |
The area or sub-area of the feature. ID on OCV. |
| FeatureAreaDisplayName | Text |
The display name of the feature area. |
| ContextFiles | Dictionary of [Text, Text] |
Map of filename to base64 file to attach to the feedback. Must contain the filename in the extension. |
| ContextProperties | Dictionary of [Text, Text] |
Additional data to pass properties to the feedback mechanism. |
RequestLikeFeedback
Requests a 'like' (positive) feedback for a feature, optionally specifying if it is a Copilot feature and its area.
procedure RequestLikeFeedback(FeatureName: Text)Parameters
| Name | Type | Description |
|---|---|---|
| FeatureName | Text |
The name of the feature for which like feedback is requested. |
RequestLikeFeedback
Requests a 'like' (positive) feedback for a feature, optionally specifying if it is a Copilot feature and its area.
procedure RequestLikeFeedback(FeatureName: Text, FeatureArea: Text, FeatureAreaDisplayName: Text)Parameters
| Name | Type | Description |
|---|---|---|
| FeatureName | Text |
The name of the feature for which like feedback is requested. |
| FeatureArea | Text |
The area or sub-area of the feature. ID on OCV. |
| FeatureAreaDisplayName | Text |
The display name of the feature area. |
RequestLikeFeedback
Requests a 'like' (positive) feedback for a feature, optionally specifying if it is a Copilot feature and its area.
procedure RequestLikeFeedback(FeatureName: Text, FeatureArea: Text, FeatureAreaDisplayName: Text, ContextFiles: Dictionary of [Text, Text], ContextProperties: Dictionary of [Text, Text])Parameters
| Name | Type | Description |
|---|---|---|
| FeatureName | Text |
The name of the feature for which like feedback is requested. |
| FeatureArea | Text |
The area or sub-area of the feature. |
| FeatureAreaDisplayName | Text |
The name of the feature for which like feedback is requested. |
| ContextFiles | Dictionary of [Text, Text] |
Map of filename to base64 file to attach to the feedback. Must contain the filename in the extension. |
| ContextProperties | Dictionary of [Text, Text] |
Additional data to pass properties to the feedback mechanism. |
RequestDislikeFeedback
Requests a 'dislike' (negative) feedback for a feature, optionally specifying if it is a Copilot feature and its area.
procedure RequestDislikeFeedback(FeatureName: Text)Parameters
| Name | Type | Description |
|---|---|---|
| FeatureName | Text |
The name of the feature for which dislike feedback is requested. |
RequestDislikeFeedback
Requests a 'dislike' (negative) feedback for a feature, optionally specifying if it is a Copilot feature and its area.
procedure RequestDislikeFeedback(FeatureName: Text, FeatureArea: Text, FeatureAreaDisplayName: Text)Parameters
| Name | Type | Description |
|---|---|---|
| FeatureName | Text |
The name of the feature for which dislike feedback is requested. |
| FeatureArea | Text |
The area or sub-area of the feature. ID of the sub-area on OCV. |
| FeatureAreaDisplayName | Text |
The display name of the feature area. |
RequestDislikeFeedback
Requests a 'dislike' (negative) feedback for a feature, optionally specifying if it is a Copilot feature and its area.
procedure RequestDislikeFeedback(FeatureName: Text, FeatureArea: Text, FeatureAreaDisplayName: Text, ContextProperties: Dictionary of [Text, Text], ContextFiles: Dictionary of [Text, Text])Parameters
| Name | Type | Description |
|---|---|---|
| FeatureName | Text |
The name of the feature for which dislike feedback is requested. |
| FeatureArea | Text |
The area or sub-area of the feature. ID of the sub-area on OCV. |
| FeatureAreaDisplayName | Text |
The display name of the feature area. |
| ContextProperties | Dictionary of [Text, Text] |
Additional data to pass properties to the feedback mechanism. |
| ContextFiles | Dictionary of [Text, Text] |
Map of filename to base64 file to attach to the feedback. Must contain the filename in the extension. |
SetIsAIFeedback
Sets whether the General/Like/Dislike feedback being collected is for an AI feature.
procedure SetIsAIFeedback(IsAIFeedback: Boolean): Codeunit "Microsoft User Feedback"Parameters
| Name | Type | Description |
|---|---|---|
| IsAIFeedback | Boolean |
True if the feedback is for an AI feature; otherwise, false. |
Returns
| Type | Description |
|---|---|
| Codeunit System.Feedback."Microsoft User Feedback" |
The current instance of the "Microsoft User Feedback Impl" codeunit. |
WithCustomQuestion
Sets a custom question to be included in the feedback prompt.
procedure WithCustomQuestion(Question: Text, QuestionDisplay: Text): Codeunit "Microsoft User Feedback"Parameters
| Name | Type | Description |
|---|---|---|
| Question | Text |
The text of the custom question. |
| QuestionDisplay | Text |
The display text of the custom question. |
Returns
| Type | Description |
|---|---|
| Codeunit System.Feedback."Microsoft User Feedback" |
The current instance of the "Microsoft User Feedback Impl" codeunit. |
WithCustomQuestionType
procedure WithCustomQuestionType(QuestionType: __MissingTypeSymbol__): Codeunit "Microsoft User Feedback"Parameters
| Name | Type | Description |
|---|---|---|
| QuestionType | __MissingTypeSymbol__ |
Returns
| Type | Description |
|---|---|
| Codeunit System.Feedback."Microsoft User Feedback" |
WithCustomQuestionRequiredBehavior
procedure WithCustomQuestionRequiredBehavior(RequiredBehavior: __MissingTypeSymbol__, Enabled: Boolean): Codeunit "Microsoft User Feedback"Parameters
| Name | Type | Description |
|---|---|---|
| RequiredBehavior | __MissingTypeSymbol__ | |
| Enabled | Boolean |
Returns
| Type | Description |
|---|---|
| Codeunit System.Feedback."Microsoft User Feedback" |
WithCustomQuestionRequiredBehavior
procedure WithCustomQuestionRequiredBehavior(RequiredBehavior: Dictionary of [__MissingTypeSymbol__, Text]): Codeunit "Microsoft User Feedback"Parameters
| Name | Type | Description |
|---|---|---|
| RequiredBehavior | Dictionary of [__MissingTypeSymbol__, Text] |
Returns
| Type | Description |
|---|---|
| Codeunit System.Feedback."Microsoft User Feedback" |
WithCustomQuestionAnswerOption
Adds an answer option for the custom question to be included in the feedback prompt.
procedure WithCustomQuestionAnswerOption(AnswerOption: Text, AnswerDisplayText: Text): Codeunit "Microsoft User Feedback"Parameters
| Name | Type | Description |
|---|---|---|
| AnswerOption | Text |
The answer option. |
| AnswerDisplayText | Text |
The display text for the answer option. |
Returns
| Type | Description |
|---|---|
| Codeunit System.Feedback."Microsoft User Feedback" |
The current instance of the "Microsoft User Feedback Impl" codeunit. |
WithCustomQuestionAnswerOptions
Sets the answer options for the custom question to be included in the feedback prompt.
procedure WithCustomQuestionAnswerOptions(AnswerOptions: Dictionary of [Text, Text]): Codeunit "Microsoft User Feedback"Parameters
| Name | Type | Description |
|---|---|---|
| AnswerOptions | Dictionary of [Text, Text] |
A dictionary defining the answer options for the custom question. |
Returns
| Type | Description |
|---|---|
| Codeunit System.Feedback."Microsoft User Feedback" |
The current instance of the "Microsoft User Feedback Impl" codeunit. |
ClearCustomQuestion
Clears any previously set custom question.
procedure ClearCustomQuestion(): Codeunit "Microsoft User Feedback"Returns
| Type | Description |
|---|---|
| Codeunit System.Feedback."Microsoft User Feedback" |
The current instance of the "Microsoft User Feedback" codeunit. |
SurveyTimerActivity
Starts or stops a survey timer activity. This is used to start a timer to count up user usage times, which can then trigger a survey prompt after a certain threshold is reached.
procedure SurveyTimerActivity(ActivityName: Text, Start: Boolean)Parameters
| Name | Type | Description |
|---|---|---|
| ActivityName | Text |
The name of the activity for which the timer is started or stopped. |
| Start | Boolean |
If true, starts the timer; if false, stops the timer. |
SurveyTriggerActivity
Sends a one-time trigger event based on a specific activity name. The event could be, for example, a user clicking a button
procedure SurveyTriggerActivity(ActivityName: Text)Parameters
| Name | Type | Description |
|---|---|---|
| ActivityName | Text |
The name of the activity that triggers the survey. |