Skip to content

[iOS] feedback present calls #780

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 5 commits into
base: master
Choose a base branch
from
Open

[iOS] feedback present calls #780

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
f8996e9
feat: iOS feedback
arifBurakDemiray Aug 12, 2025
4365b8b
feat: iOS feedback to current
arifBurakDemiray Aug 12, 2025
2b4ff38
Update current.md
arifBurakDemiray Aug 12, 2025
463bebd
Update current.md
arifBurakDemiray Aug 12, 2025
d1969e4
Update next.md
arifBurakDemiray Aug 12, 2025
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
224 changes: 138 additions & 86 deletions ios/current.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3063,112 +3063,126 @@ config.starRatingDismissButtonTitle = "No, thanks."</code></pre>
</p>
</div>
<p>
When the widgets are created, you need to use 2 calls in your SDK: one to get
all available widgets for a user and another to display a chosen widget.
After you have created widgets on your dashboard, you can reach the methods to
show them from the feedback interface of your Countly instance:
</p>
<p>To get your available widget list, use the call below.</p>
<div class="tabs">
<div class="tabs-menu">
<span class="tabs-link is-active">Objective-C</span>
<span class="tabs-link">Swift</span>
</div>
<div class="tab">
<pre><code class="objectivec">
[Countly.sharedInstance getFeedbackWidgets:^(NSArray * feedbackWidgets, NSError * error)
{
if (error)
{
NSLog(@"Getting widgets list failed. Error: %@", error);
}
else
{
NSLog(@"Getting widgets list successfully completed. %@", [feedbackWidgets description]);
}
}];
</code></pre>
<pre><code class="objectivec">[Countly.sharedInstance feedback];</code></pre>
</div>
<div class="tab is-hidden">
<pre><code class="swift">
Countly.sharedInstance().getFeedbackWidgets
{ (feedbackWidgets: [CountlyFeedbackWidget], error) in
if (error != nil)
{
print("Getting widgets list failed. \n \(error!.localizedDescription) \n \((error! as NSError).userInfo)")
}
else
{
print("Getting widgets list successfully completed. \(String(describing: feedbackWidgets))")
}
}</code></pre>
<pre><code class="swift">Countly.sharedInstance().feedback()</code></pre>
</div>
</div>
<p>
When feedback widgets are fetched successfully, <code>completionHandler</code>
will be executed with an array of <code>CountlyFeedbackWidget</code> objects.
Otherwise, <code>completionHandler</code> will be executed with an
<code>NSError</code>.
</p>
<p>
Calls to this method will be ignored and <code>completionHandler</code> will
not be executed if:<br>
- Consent for <code>CLYConsentFeedback</code> is not given, while
<code>requiresConsent</code> flag is set on initial configuration.<br>
- Current device ID is <code>CLYTemporaryDeviceID</code>.
</p>
<p>
Once you get the list, you can inspect <code>CountlyFeedbackWidget</code> objects
in it, by checking their <code>type</code>, <code>ID</code>, and
<code>name</code> properties to decide which one to display. And when you decide,
you can use <code>present</code> method on <code>CountlyFeedbackWidget</code>
object to display it.
You can display a random active widget for the widget type you want with one
of these methods:
</p>
<div class="tabs">
<div class="tabs-menu">
<span class="tabs-link is-active">Objective-C</span>
<span class="tabs-link">Swift</span>
</div>
<div class="tab">
<pre><code class="objectivec">CountlyFeedbackWidget * aFeedbackWidget = feedbackWidgets.firstObject; //assuming we want to display the first one in the list
[aFeedbackWidget present];
<pre><code class="objectivec">[presentNPS]
[presentSurvey]
[presentRating]
// Example:
[Countly.sharedInstance.feedback presentNPS];
</code></pre>
</div>
<div class="tab is-hidden">
<pre><code class="swift">let aFeedbackWidget : CountlyFeedbackWidget? = feedbackWidgets?.first //assuming we want to display the first one in the list
aFeedbackWidget?.present()
<pre><code class="swift">.presentNPS()
.presentSurvey()
.presentRating()
// Example:
Countly.sharedInstance().feedback().presentNPS()
</code></pre>
</div>
</div>
<p>Optionally you can pass appear and dismiss callback blocks:</p>
<p>
If you want to show a specific widget according to its name, ID or one of its
tags then you can use these methods:
</p>
<div class="tabs">
<div class="tabs-menu">
<span class="tabs-link is-active">Objective-C</span>
<span class="tabs-link">Swift</span>
<div class="tabs">
<div class="tabs-menu">
<span class="tabs-link is-active">Objective-C</span>
<span class="tabs-link">Swift</span>
</div>
<div class="tab">
<pre><code class="objectivec">[presentNPS:nameIDorTag
[presentSurvey:nameIDorTag]
[presentRating:nameIDorTag]
// Example:
[Countly.sharedInstance.feedback presentNPS:@"/home-page"];
</code></pre>
</div>
<div class="tab is-hidden">
<pre><code class="swift">.presentNPS(nameIDorTag)
.presentSurvey(nameIDorTag)
.presentRating(nameIDorTag)
// Example:
Countly.sharedInstance().feedback().presentNPS("/home-page")
</code></pre>
</div>
</div>
</div>
<div class="tab">
<pre><code class="objectivec">CountlyFeedbackWidget * aFeedbackWidget = feedbackWidgets.firstObject; //assuming we want to display the first one in the list
[aFeedbackWidget presentWithAppearBlock:^
{
NSLog(@"Appeared!");
}
andDismissBlock:^
{
NSLog(@"Dismissed!");
</div>
<p>
If an empty nameIDorTag is provided it will show the first feedback widget by
its type.
</p>
<p>
If you need to know when the widget is appeared or closed you can use these methods
to provide a callback which will be called when the widget appeared/closes:
</p>
<div class="tabs">
<div class="tabs-menu">
<div class="tabs">
<div class="tabs-menu">
<span class="tabs-link is-active">Objective-C</span>
<span class="tabs-link">Swift</span>
</div>
<div class="tab">
<pre><code class="objectivec">[presentNPS:nameIDorTag widgetCallback:]
[presentSurvey:nameIDorTag widgetCallback:]
[presentRating:nameIDorTag widgetCallback:]
// Example:
[Countly.sharedInstance.feedback presentNPS:@"MyNetPromoterScore" widgetCallback:^(WidgetState widgetState) {
//...
}];
</code></pre>
</div>
<div class="tab is-hidden">
<pre><code class="swift">let aFeedbackWidget : CountlyFeedbackWidget? = feedbackWidgets?.first //assuming we want to display the first one in the list
aFeedbackWidget?.present(appear:
{
print("Appeared.")
},
andDismiss:
{
print("Dismissed.")
</code></pre>
</div>
<div class="tab is-hidden">
<pre><code class="swift">.presentNPS(nameIDorTag, widgetCallback)
.presentSurvey(nameIDorTag, widgetCallback)
.presentRating(nameIDorTag, widgetCallback)
// Example:
Countly.sharedInstance().feedback().presentNPS("MyNetPromoterScore") { widgetState in
//...
})
</code></pre>
</code></pre>
</div>
</div>
</div>
</div>
<p>
<code class="swift">widgetState</code> enum has two values
<code class="swift">WIDGET_APPEARED</code> and
<code class="swift">WIDGET_CLOSED</code>, on the basis of widget state you know
about whether widget is appeared or closed.
</p>
<p>
For more in-depth information on retrieving feedback widgets, understanding object
structures, or presenting them yourself, please refer to the following
<a href="https://support.countly.com/hc/en-us/articles/9290669873305-A-Deeper-Look-at-SDK-concepts#h_01HABT18WTFWFNKVPJJ6G6DEM4">resource</a>.
</p>
<h3 id="h_01HAVHW0RRR7N3A283E2YQQT1Z">Manual Reporting</h3>
<p>
Optionally you can fetch feedback widget data and create your own UI using:
Expand All @@ -3180,34 +3194,55 @@ andDismiss:
</div>
<div class="tab">
<pre><code class="objectivec">
CountlyFeedbackWidget * aFeedbackWidget = feedbackWidgets.firstObject; //assuming we want to display the first one in the list
[aFeedbackWidget getWidgetData:^(NSDictionary * widgetData, NSError * error)
[Countly.sharedInstance getFeedbackWidgets:^(NSArray * feedbackWidgets, NSError * error)
{
if (error)
{
NSLog(@"Getting widget data failed. Error: %@", error);
NSLog(@"Getting widgets list failed. Error: %@", error);
}
else
{
NSLog(@"Getting widget data successfully completed. %@", [widgetData description]);
CountlyFeedbackWidget * aFeedbackWidget = feedbackWidgets.firstObject; //assuming we want to display the first one in the list
[aFeedbackWidget getWidgetData:^(NSDictionary * widgetData, NSError * error)
{
if (error)
{
NSLog(@"Getting widget data failed. Error: %@", error);
}
else
{
NSLog(@"Getting widget data successfully completed. %@", [widgetData description]);
}
}];
}
}];
</code></pre>
</div>
<div class="tab is-hidden">
<pre><code class="swift">
let aFeedbackWidget : CountlyFeedbackWidget? = feedbackWidgets?.first //assuming we want to display the first one in the list
aFeedbackWidget?.getData
{ (widgetData: [AnyHashable: Any]?, error: Error?) in
Countly.sharedInstance().getFeedbackWidgets
{ (feedbackWidgets: [CountlyFeedbackWidget], error) in
if (error != nil)
{
print("Getting widget data failed. Error \(error.debugDescription)")
print("Getting widgets list failed. \n \(error!.localizedDescription) \n \((error! as NSError).userInfo)")
}
else
{
print("Getting widget data successfully completed. \(String(describing: widgetData))")
let aFeedbackWidget : CountlyFeedbackWidget? = feedbackWidgets?.first //assuming we want to display the first one in the list
aFeedbackWidget?.getData
{ (widgetData: [AnyHashable: Any]?, error: Error?) in
if (error != nil)
{
print("Getting widget data failed. Error \(error.debugDescription)")
}
else
{
print("Getting widget data successfully completed. \(String(describing: widgetData))")
}
}
}
} </code></pre>
}
</code></pre>
</div>
</div>
<p>
Expand Down Expand Up @@ -4241,7 +4276,7 @@ Countly.sharedInstance().cancelConsent(forFeature: CLYConsentEvents)</code></pre
<pre><code class="swift">config.sdkInternalLimits().setMaxStackTraceLineLength(300);</code></pre>
</div>
</div>
<h2 id="h_01JSKRSAXEH9RYJ8X22P3GEH45">SDK Behavior Settings</h2>
<h2 id="h_01JSKRSAXEH9RYJ8X22P3GEH45">Server Configuration</h2>
<p>
Server Configuration is enabled by default. Changes made on SDK Manager SDK Configuration
on your server will affect SDK behavior directly.
Expand All @@ -4263,6 +4298,23 @@ Countly.sharedInstance().cancelConsent(forFeature: CLYConsentEvents)</code></pre
<pre><code class="swift">config.sdkBehaviorSettings = "json server config";</code></pre>
</div>
</div>
<p>
If you want to disable automatic config updates from the server, you can prevent
the SDK from making server configuration fetch requests. This is useful if you're
trying to reduce network traffic or control request counts.
</p>
<div class="tabs">
<div class="tabs-menu">
<span class="tabs-link is-active">Objective-C</span>
<span class="tabs-link">Swift</span>
</div>
<div class="tab">
<pre><code class="objectivec">config.disableSDKBehaviorSettingsUpdates = YES;</code></pre>
</div>
<div class="tab is-hidden">
<pre><code class="swift">config.disableSDKBehaviorSettingsUpdates = true</code></pre>
</div>
</div>
<h2 id="h_01HAVHW0RSTYHES6WSX8Z80BQ6">Attribution</h2>
<h3 id="h_01HAVHW0RSD4315V1VW115EWVS">Direct Attribution</h3>
<p>
Expand Down Expand Up @@ -5328,4 +5380,4 @@ Countly.sharedInstance().changeDeviceIDWithoutMerge("new_device_id")</code></pre
Notification is not coming from Countly and it does not have any value for
<code>kCountlyPNKeyNotificationID = @"i"</code> key in it
</li>
</ol>
</ol>
Loading