Use 6-digit codes
By default, Cobrowse does not require any visible UI presented to the user. It will exist in the background of your app, and only activate when agents initiate a new session.
You may optionally present a UI in your app that enables users to generate 6-digit codes. Users may then read a code over the phone or in chat, and agents can use the 6-digit code to initiate the Cobrowse session.
Important: 6-digit codes expire after approximately 15 minutes, so it's best practice to generate a code only when a user wants to start a session.
To generate a 6-digit code in your integration you can use the following APIs. Once you have generated the code you can display it to the user in your own UI. You should only generate a code when a user needs it as they expire shortly after creation.
Web
iOS / MacOS
React Native
Android
Xamarin
Windows
// ensure Cobrowse is loaded
CobrowseIO.client().then(function() {
// create a code a display it to the user using your own UI
CobrowseIO.createSessionCode().then(function(code) {
console.log('your code is', code);
});
});
If you are only using 6 digit codes to start Cobrowse sessions in your implementation, you can add the following option to your call to
CobrowseIO.start() in the default snippet we provide. This will prevent our SDK contacting the Cobrowse server until a screen sharing session is required.CobrowseIO.start({register:false})
[CobrowseIO.instance createSession:^(NSError * err, CBIOSession * session) {
if (err) NSLog(@"Failed to create code")
else NSLog(@"%@", session.code);
}];
const session = await CobrowseIO.createSession()
console.log('Your 6 digit code is', session.code)
CobrowseIO.instance().createSession((err, session) -> {
if (err != null) Log.w("App", "Failed to create code");
else if (session != null) Log.i("App", "Session code " + session.code());
});
CobrowseIO.Instance.CreateSession((Exception err, ISession session) => {
if (err != null) Debug.WriteLine("Failed to create a code");
else if (session != null) Debug.WriteLine("Session code " + session.Code);
});
Session session = await CobrowseIO.Instance.CreateSession();
Console.WriteLine("Code: {0}", session.Code);
You can monitor changes in the state of the session using the Cobrowse delegate methods to listen for events:
We provide a very simple default plug-and-play UI that provides the 6-digit code display functionality. We also provide a set of public methods if you prefer to build a custom UI (see above). Learn more at Customize the interface.
Web
iOS
Android
React Native
Xamarin
MacOS
Windows
The Cobrowse.io SDK for web does not provide a default UI for generating 6 digit codes.
- 1.Add the appropriate code below into a view controller in your app.
- 2.Hook up a trigger for the action (or call it programatically if you prefer).
import CobrowseIO
class ExampleViewController: UIViewController {
var sessionController: CBIOViewController!
@IBAction func startCobrowse(sender: UIBarButtonItem) {
self.sessionController = CBIOViewController()
self.navigationController?.pushViewController(self.sessionController, animated: true)
}
// ... the rest of your view controller
}
For a full example written in Swift, see our Listr sample app at: https://github.com/cobrowseio/Listr
@import CobrowseIO;
@implementation ExampleViewController {
CBIOViewController* sessionController;
}
-(IBAction) startCobrowse:(id)sender {
sessionController = [[CBIOViewController alloc] init];
[self.navigationController pushViewController:sessionController animated:YES];
}
// ... the rest of your view controller
@end
Make sure you've hooked up a trigger for the
startCobrowse IBAction that we've just added. Then head to https://cobrowse.io/dashboard and enter the 6 digit code that will be generated by your app when you trigger the action!import io.cobrowse.ui.CobrowseActivity;
public class YourActivity extends Activity {
// the rest of your Activity
public void startCobrowse(View view) {
Intent intent = new Intent(this, CobrowseActivity.class);
startActivity(intent);
}
}
Make sure you've hooked up a trigger for the
startCobrowse method that we've just added. Then head to https://cobrowse.io/dashboard and enter the 6 digit code that will be generated by your app when you trigger the action!We've provided a view that will do all the session creation and management for you. All you need to do is include this somewhere in your react native view hierarchy. It's not a requirement to use this UI, you can easily build your own if you like!
import { CobrowseView } from 'cobrowse-sdk-react-native';
export default class App extends Component {
render() {
return (
<View>
<CobrowseView />
</View>
);
}
}
- 1.Add the appropriate code below into a view controller in your app.
- 2.Hook up a trigger for the action (or call it programatically if you prefer).
using Xamarin.CobrowseIO;
namespace SampleApp.iOS
{
public partial class ViewController : UIViewController
{
private void StartCobrowse(object sender, EventArgs e)
{
NavigationController.PushViewController(new CobrowseViewController(), animated: true);
}
}
}
For a full example written in C#, see our sample app at: https://github.com/cobrowseio/cobrowse-sdk-xamarin
We have provided some default UI to make things easier to get started:
using Xamarin.CobrowseIO;
using Xamarin.CobrowseIO.UI;
namespace SampleApp.Android
{
[Activity]
public class MainActivity : AppCompatActivity
{
private void StartCobrowse(object sender, EventArgs e)
{
var intent = new Intent(this, typeof(CobrowseActivity));
StartActivity(intent);
}
}
}
The Cobrowse.io Xamarin SDK provides a convenient way to open the default 6 digit code UI. In your cross-platform project:
using Xamarin.CobrowseIO.Abstractions;
namespace YourAppNamespace.Forms
{
public partial class YourPage : Xamarin.Forms.Page
{
public void StartCobrowse()
{
CobrowseIO.Instance.OpenCobrowseUI();
}
}
}
The Cobrowse.io SDK for MacOS does not provide a default UI for generating 6 digit codes.
The Cobrowse.io SDK for Windows does not provide a default UI for generating 6 digit codes, instead you can generate a code for your UI by using the
CreateSession API.To see some code samples for how to build a custom UI for your platform see:
Last modified 9mo ago