Ubuntu Platform API  3.0.0
A library helping with tight integration into the Ubuntu platform
Functions and types to provide launching files/applications.

Applications in Ubuntu can not launch other applications directly. They have to use the url_dispatcher service to open other applications or to open applications that handle a given url. More...

Typedefs

typedef struct UbuntuApplicationUrlDispatcherSession UAUrlDispatcherSession
 Opaque type encapsulating a session with the url dispatcher service. More...
 
typedef void(* UAUrlDispatcherSessionDispatchHandler) (UStatus status, const char *url, void *context)
 Callback type that is invoked for open results. More...
 

Functions

UBUNTU_DLL_PUBLIC void ua_url_dispatcher_session_open (UAUrlDispatcherSession *session, const char *url, UAUrlDispatcherSessionDispatchHandler handler, void *context)
 Tells the url dispatcher to open the given url. More...
 

Detailed Description

Applications in Ubuntu can not launch other applications directly. They have to use the url_dispatcher service to open other applications or to open applications that handle a given url.

Typedef Documentation

◆ UAUrlDispatcherSession

typedef struct UbuntuApplicationUrlDispatcherSession UAUrlDispatcherSession

Opaque type encapsulating a session with the url dispatcher service.

Definition at line 33 of file session.h.

◆ UAUrlDispatcherSessionDispatchHandler

typedef void(* UAUrlDispatcherSessionDispatchHandler) (UStatus status, const char *url, void *context)

Callback type that is invoked for open results.

Parameters
[out]statusU_STATUS_SUCCESS if the dispatching was successful.
[out]urlThe url passed to the ua_url_dispatcher_session_dispatch call.
[out]contextThe url context passed to the ua_url_dispatcher_session_dispatch call.

Definition at line 43 of file session.h.

Function Documentation

◆ ua_url_dispatcher_session_open()

UBUNTU_DLL_PUBLIC void ua_url_dispatcher_session_open ( UAUrlDispatcherSession session,
const char *  url,
UAUrlDispatcherSessionDispatchHandler  handler,
void *  context 
)

Tells the url dispatcher to open the given url.

Parameters
[in]sessionThe session instance.
[in]urlThe url to open.
[in]handlerThe url dispatcher open handler.
[in]contextYour context, will be returned to you as is in the handler callback.