⛔ [DEPRECATED] This repository is no longer actively maintained. You may fork the project but we are no longer accepting pull requests or new issues. You may reach out to [email protected] with questions.
The UserVoice iOS SDK allows you to integrate a native UserVoice experience directly in your iPhone or iPad app, allowing you to provide Instant Answers to your customers’ questions, a searchable knowledge base, and feedback forum. Our contact form is a friendlier experience than an email composer filled with debug information, and also eliminates those blank requests clogging up your inbox.
The recommended way to install the UserVoice SDK is to use CocoaPods.
pod 'uservoice-iphone-sdk', '~> 3.2'
Alternatively, you can install by hand:
- Download the latest build.
- Drag
UVHeaders,UVResources, andlibUserVoice.ainto your project.- When adding the folders, make sure you have "Create groups for any added folders" selected rather than "Create folder references for any added folders".
- Note that the
.hfiles inUVHeadersdo not need to be added to your target. - Add QuartzCore and SystemConfiguration frameworks to your project.
The SDK is easily callable from Swift. You just need to:
- Add
pod 'uservoice-iphone-sdk', '~> 3.2'to your Podfile pod install- Add
#import "UserVoice.h"to your bridging header - Create a config:
var config = UVConfig(site: "demo.uservoice.com") - Pass the config:
UserVoice.initialize(config) - Launch the SDK:
UserVoice.presentUserVoiceInterfaceForParentViewController(self)
See the swift example repo for a working example.
Once you have completed these steps, you are ready to launch the UserVoice UI from your code. Import UserVoice.h and create a UVConfig using one of the following options.
Start by creating a UVConfig object like this:
UVConfig *config = [UVConfig configWithSite:@"yoursite.uservoice.com"];
Once you've set up your config the way you want it, you should go ahead and pass it to initialize:
[UserVoice initialize:config];
This should be called when your app starts up so that we can provide accurate metrics in your UserVoice admin console.
If you know who your user is, you can pass in their identity so that they won't have to enter their name or email to send tickets or post ideas.
[config identifyUserWithEmail:@"[email protected]" name:@"Example User" guid:@"123"];
GUID can be the same as email, but if you have an internal user id, you can pass that so that the user's account will have continuity if they later change their email address.
Note: One limitation is that this will not work if the email address matches an admin on your UserVoice account (for security reasons). Admins will still be able to use the iOS SDK but they will need to sign in the first time they do. If you are testing this feature, make sure you are not testing with an admin account.
You can specify which forum users will interact with by id. If you do not specify a forum, it will use the default forum for your account.
config.forumId = 123;
You can turn off certain features of the SDK if you do not want to use them. By default, all features are enabled if they are available on your account.
1. Turn off browsing the forum. The user will still be able to post ideas, and view ideas that they find by searching.
config.showForum = NO;
2. Turn off posting ideas. The user will still be able to browse and search existing ideas.
config.showPostIdea = NO;
3. Turn off the contact form.
config.showContactUs = NO;
4. Turn of the knowledge base. This only affects the knowledge base browser on the portal screen. Instant answers will still include articles.
config.showKnowledgeBase = NO;
If you deep-link to an area that is turned off (such as the contact form), it will still work. Turning off the feature only prevents it from being accessible anywhere in the UserVoice UI.
There are 4 options for how to launch UserVoice from within your app:
1. Standard UserVoice Interface: This launches the UserVoice for iOS portal page where the user can browse suggestions, contact you or browse the knowledgebase. This is the full experience of everything the SDK can do.
[UserVoice presentUserVoiceInterfaceForParentViewController:self];
2. Direct link to contact form: Launches user directly into the contact form, with Instant Answers, experience. Useful to link to from error or setup pages in your app.
[UserVoice presentUserVoiceContactUsFormForParentViewController:self];
3. Direct link to feedback forum: Launches the user directly into the feedback forum where they can browse, vote on or give their own feedback. Useful for linking from a "Give us your ideas?" prompt from within your app.
[UserVoice presentUserVoiceForumForParentViewController:self];
4. Direct link to idea form: Launches user directly into the idea form, with Instant Answers, experience.
[UserVoice presentUserVoiceNewIdeaFormForParentViewController:self];
You can optionally pass further information about your users into UserVoice. This will allow us to provide you more useful reports about your users.
config.userTraits = @{
@"created_at" : @(1364406966), // Unix timestamp for the date the user signed up
@"type" : @"Owner", // Optional: segment your users by type
@"account" : @{
@"id" : @(123), // Optional: associate multiple users with a single account
@"name" : @"Acme, Co.", // Account name
@"created_at" : @(1364406966), // Unix timestampe for the date the account was created
@"monthly_rate" : @(9.99), // Decimal; monthly rate of the account
@"ltv" : @(1495.00), // Decimal; lifetime value of the account
@"plan" : @"Enhanced" // Plan name for the account
}
};
You can also customize the appearance of the UserVoice user interface by setting certain key colors.
#import "UVStyleSheet.h"
[UVStyleSheet instance].tintColor = [UIColor redColor];
[UVStyleSheet instance].tableViewBackgroundColor = [UIColor whiteColor];
See UVStyleSheet.h for a complete list of the visual properties you can modify.
The library will detect and display in the language the device is set to provided that language is supported by the SDK (see currently supported languages.).
Note: UserVoice for iOS does not support private forums. This section is relevant to those using sitewide privacy.
The SDK relies on being able to obtain a client key to communicate with the UserVoice API. If you have a public UserVoice site (the default) then it can obtain this key automatically, so you only need to pass your site URL. However, if you turn on site privacy, this key is also private, so you will need to pass it in. You can obtain a client key pair from the "Integrations" settings section of the UserVoice admin console. Private sites are not supported unless the user is authenticated.
UVConfig *config = [UVConfig configWithSite:@"yoursite.uservoice.com" andKey:@"CLIENT_KEY" andSecret:@"CLIENT_SECRET"];
[UserVoice initialize:config];
The UserVoice Platform, including iOS & Android SDKs, is not COPPA compliant and should not be used in apps marketed at children.
- You should pass your
UVConfigto+[UserVoice initialize:]shortly after app launch so that we can provide you with accurate usage reports. - If you are using a custom stylesheet, you will need to update your code as both the set of options and the method of setting them have changed. See the section below on Customizing Colors.
- You no longer need to pass a client key pair to UVConfig unless you have restricted access enabled on your UserVoice site.
- We are dropping support for versions of iOS prior to 6.0. (See note about iOS versions)
You can also specify a help topic by id. If you don't then it will display a list of all topics in your account, as long as they contain at least one article.
config.topicId = 123;
You can set ticket field values on the UVConfig object. These will be used
associated with any tickets the user creates during their session. You can
also use this to set default values for ticket fields on the contact form.
Note: You must first configure these fields in the UserVoice admin console. If you pass fields that are not recognized by the server, they will be ignored.
config.customFields = @{@"Key" : @"Value"};
You can share feedback on our Mobile SDKs forum.
What if I only want to collect feedback? What if I only want a contact form? Don’t worry. UserVoice is a modular system and you can link to only the parts of the SDK you want to use. Check out how you can configure invocation.
Why would I use this over a Mail link? There are a lot of reasons why UserVoice for iOS is superior to a Mail link:
- It doesn’t take your users out of your app.
- It’s a more efficient way to scale customer support and engagement:
- UserVoice automatically suggests articles and forum posts that help solve users’ issues before they contact you. We call it Instant Answers and it can reduce your support load by up to 40%.
- We've shown it can reduce junk emails (people clicking send to get out of the email app) by up to 74%.
- You can setup custom fields to ask custom questions and pass in environment information (account IDs) that help your agents answer questions faster, reducing the back and forth between agents and customers.
- By having a dedicated space for users to give feedback and vote up other users’ ideas, not only will you get more feedback (and more prioritized feedback), but you’ll also reduce the number of feature requests that end up in your support queue.
What if I have a web app as well? No problemo! Every UserVoice account comes with a yourname.uservoice.com site and web widgets so you can administer both your mobile and web users from your UserVoice admin console.
What about users who still send in email for support? UserVoice can handle that as well. Simply setup your existing support email forward to your UserVoice tickets email address ([email protected]).
Does it pass device ids or anything that would get me in trouble with Apple? Nope. UserVoice for iOS follows all of Apple’s policies to make sure you can confidently include our SDK in your app.
Can I customize the look and feel to match my app? Yes. You can customize the colors of the UserVoice modal dialogs by creating your own stylesheet. Check out the customization for more info.
UserVoice for iOS now has support for the following locales: af, ca, cs, da, de, el, en-GB, en, es, fi, fr, hr, hu, id, it, ja, ko, ms, nb, nl, pl, pt-PT, pt, ro, ru, sk, sv, th, tr, uk, vi, zh-Hans, zh-Hant.
If you have done an additional translation, we would love to pull it in so that everyone can benefit. Just fork the project and submit a pull request.
Some strings that show up in the SDK may come directly from the UserVoice API. If a translation is missing for a string that does not appear in the SDK codebase, you will need to contribute to the main UserVoice translation site.
- UserVoice for iOS 3.0 is designed for iOS 8 with backwards compatibility for iOS 6
- To support earlier versions you would have to go back to UserVoice for iOS 2.0
If you want to use UserVoice for iOS 3.0 in your app, but your app also supports iOS 5 or earlier, you will need to tweak your build settings to prevent your app from crashing on launch on old versions of iOS. This is because UserVoice for iOS is typically installed as a static library, and it references classes that are not available on iOS 5. There are 2 options:
- Go into Build Settings for your target and change the Foundation and UIKit frameworks from "Required" to "Optional". This means that every class in those frameworks will be resolved when it is first used rather than on app launch.
- Alternatively, pull the UserVoice code into a Vendor directly in your project rather than referencing it as a static library. This is only an option if your project uses ARC.
In either case, you will also need to prevent your users from launching UserVoice on an unsupported version of iOS. Something like this should suffice:
if ([UIDevice currentDevice].systemVersion.floatValue < 6) {
// hide button that invokes UserVoice
}
Special thanks to:
- netbe for the French translation
- Piero87 for the Italian translation
- zetachang for the Traditional Chinese translation
- nvh for the Dutch translation
- vinzenzweber and Blockhaus Media for the German translation
- hebertialmeida for the Portuguese translation
- Everyone else who reported bugs or made pull requests!
Copyright 2010 UserVoice Inc.
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.