IVRMenu Class Reference

#include <switch_cpp.h>

Collaboration diagram for IVRMenu:

Public Member Functions
	IVRMenu (IVRMenu *main, const char *name, const char *greeting_sound, const char *short_greeting_sound, const char *invalid_sound, const char *exit_sound, const char *transfer_sound, const char *confirm_macro, const char *confirm_key, const char *tts_engine, const char *tts_voice, int confirm_attempts, int inter_timeout, int digit_len, int timeout, int max_failures, int max_timeouts)
virtual	~IVRMenu ()
void	bindAction (char *action, const char *arg, const char *bind)
void	execute (CoreSession *session, const char *name)
	IVRMenu (IVRMenu *main, const char *name, const char *greeting_sound, const char *short_greeting_sound, const char *invalid_sound, const char *exit_sound, const char *transfer_sound, const char *confirm_macro, const char *confirm_key, const char *tts_engine, const char *tts_voice, int confirm_attempts, int inter_timeout, int digit_len, int timeout, int max_failures, int max_timeouts)
virtual	~IVRMenu ()
void	bindAction (char *action, const char *arg, const char *bind)
void	execute (CoreSession *session, const char *name)

Protected Attributes
switch_ivr_menu_t *	menu
switch_memory_pool_t *	pool

Detailed Description

Definition at line 83 of file switch_cpp.h.

Constructor & Destructor Documentation

IVRMenu::IVRMenu	(	IVRMenu *	main,
		const char *	name,
		const char *	greeting_sound,
		const char *	short_greeting_sound,
		const char *	invalid_sound,
		const char *	exit_sound,
		const char *	transfer_sound,
		const char *	confirm_macro,
		const char *	confirm_key,
		const char *	tts_engine,
		const char *	tts_voice,
		int	confirm_attempts,
		int	inter_timeout,
		int	digit_len,
		int	timeout,
		int	max_failures,
		int	max_timeouts
	)

Definition at line 161 of file switch_cpp.cpp.

References menu, pool, switch_assert, switch_core_new_memory_pool, switch_ivr_menu_init(), and zstr.

{
        menu = NULL;
        switch_core_new_memory_pool(&pool);
        switch_assert(pool);
        if (zstr(name)) {
                name = "no name";
        }

        switch_ivr_menu_init(&menu, main ? main->menu : NULL, name, greeting_sound, short_greeting_sound, invalid_sound, 
                                                 exit_sound, transfer_sound, confirm_macro, confirm_key, tts_engine, tts_voice, confirm_attempts, inter_timeout,
                                                 digit_len, timeout, max_failures, max_timeouts, pool);
        

}

IVRMenu::~IVRMenu ( )

virtual

Definition at line 193 of file switch_cpp.cpp.

References menu, pool, switch_core_destroy_memory_pool, and switch_ivr_menu_stack_free().

{
        if (menu) {
                switch_ivr_menu_stack_free(menu);
        }
        switch_core_destroy_memory_pool(&pool);
}

IVRMenu::IVRMenu	(	IVRMenu *	main,
		const char *	name,
		const char *	greeting_sound,
		const char *	short_greeting_sound,
		const char *	invalid_sound,
		const char *	exit_sound,
		const char *	transfer_sound,
		const char *	confirm_macro,
		const char *	confirm_key,
		const char *	tts_engine,
		const char *	tts_voice,
		int	confirm_attempts,
		int	inter_timeout,
		int	digit_len,
		int	timeout,
		int	max_failures,
		int	max_timeouts
	)

virtual IVRMenu::~IVRMenu ( )

virtual

Member Function Documentation

void IVRMenu::bindAction	(	char *	action,
		const char *	arg,
		const char *	bind
	)

Definition at line 201 of file switch_cpp.cpp.

References SWITCH_CHANNEL_LOG, SWITCH_IVR_ACTION_NOOP, switch_ivr_menu_bind_action(), switch_ivr_menu_str2action(), SWITCH_LOG_DEBUG, SWITCH_LOG_ERROR, switch_log_printf(), SWITCH_STATUS_SUCCESS, and this_check_void.

{
        switch_ivr_action_t ivr_action = SWITCH_IVR_ACTION_NOOP;

        this_check_void();
        
        if (switch_ivr_menu_str2action(action, &ivr_action) == SWITCH_STATUS_SUCCESS) {
                switch_log_printf(SWITCH_CHANNEL_LOG, SWITCH_LOG_DEBUG, "bind %s to %s(%s)\n", bind, action, arg);
                switch_ivr_menu_bind_action(menu, ivr_action, arg, bind);
        } else {
                switch_log_printf(SWITCH_CHANNEL_LOG, SWITCH_LOG_ERROR, "invalid action %s\n", action);
        }
}

void IVRMenu::bindAction	(	char *	action,
		const char *	arg,
		const char *	bind
	)

void IVRMenu::execute	(	CoreSession *	session,
		const char *	name
	)

void IVRMenu::execute	(	CoreSession *	session,
		const char *	name
	)

Definition at line 215 of file switch_cpp.cpp.

References switch_ivr_menu_execute(), and this_check_void.

{
        this_check_void();
        switch_ivr_menu_execute(session->session, menu, (char *)name, NULL);
}

Field Documentation

switch_ivr_menu_t * IVRMenu::menu

protected

Definition at line 85 of file switch_cpp.h.

Referenced by IVRMenu(), and ~IVRMenu().

switch_memory_pool_t * IVRMenu::pool

protected

Definition at line 86 of file switch_cpp.h.

Referenced by IVRMenu(), and ~IVRMenu().

---

The documentation for this class was generated from the following files:

• switch_cpp.h
• switch_swigable_cpp.h
• switch_cpp.cpp