fl_method_call.h File Reference

#include <glib-object.h>
#include <gmodule.h>
#include "fl_method_response.h"
#include "fl_value.h"

Go to the source code of this file.

Functions
G_BEGIN_DECLS G_MODULE_EXPORT const gchar *	fl_method_call_get_name (FlMethodCall *method_call)
FlValue *	fl_method_call_get_args (FlMethodCall *method_call)
gboolean	fl_method_call_respond (FlMethodCall *method_call, FlMethodResponse *response, GError **error)
gboolean	fl_method_call_respond_success (FlMethodCall *method_call, FlValue *result, GError **error)

Function Documentation

fl_method_call_get_args()

FlValue * fl_method_call_get_args

(

FlMethodCall *

method_call

)

fl_method_call_get_args: @method_call: an #FlMethodCall.

Gets the arguments passed to the method.

Returns: an FlValue.

Definition at line 72 of file fl_method_call.cc.

                                                                     {
  g_return_val_if_fail(FL_IS_METHOD_CALL(self), nullptr);
  return self->args;
}

fl_method_call_get_name()

G_BEGIN_DECLS G_MODULE_EXPORT const gchar * fl_method_call_get_name

(

FlMethodCall *

method_call

)

FlMethodCall:

#FlMethodCall represents and incoming method call as returned by an #FlMethodChannel. fl_method_call_get_name: @method_call: an #FlMethodCall.

Gets the name of the method call.

Returns: a method name.

Definition at line 67 of file fl_method_call.cc.

                                                                         {
  g_return_val_if_fail(FL_IS_METHOD_CALL(self), nullptr);
  return self->name;
}

fl_method_call_respond()

gboolean fl_method_call_respond	(	FlMethodCall *	method_call,
		FlMethodResponse *	response,
		GError **	error
	)

fl_method_call_respond: @method_call: an #FlMethodCall. @response: an #FlMethodResponse. @error: (allow-none): #GError location to store the error occurring, or NULL to ignore.

Responds to a method call.

Returns: TRUE on success.

Definition at line 77 of file fl_method_call.cc.

                                                                {
  g_return_val_if_fail(FL_IS_METHOD_CALL(self), FALSE);
  g_return_val_if_fail(FL_IS_METHOD_RESPONSE(response), FALSE);
 
  g_autoptr(GError) local_error = nullptr;
  if (!fl_method_channel_respond(self->channel, self->response_handle, response,
                                 &local_error)) {
    // If the developer chose not to handle the error then log it so it's not
    // missed.
    if (error == nullptr) {
      g_warning("Failed to send method call response: %s",
                local_error->message);
    }
 
    g_propagate_error(error, local_error);
    return FALSE;
  }
 
  return TRUE;
}

fl_method_call_respond_success()

gboolean fl_method_call_respond_success	(	FlMethodCall *	method_call,
		FlValue *	result,
		GError **	error
	)

fl_method_call_respond_success: @method_call: an #FlMethodCall.

Returns

: (allow-none): value to respond with, must match what the #FlMethodCodec supports. @error: (allow-none): #GError location to store the error occurring, or NULL to ignore.

Convenience method that responds to method call with #FlMethodSuccessResponse.

Returns: TRUE on success.

Definition at line 100 of file fl_method_call.cc.

                                                                        {
  g_return_val_if_fail(FL_IS_METHOD_CALL(self), FALSE);
 
  g_autoptr(FlMethodResponse) response =
      FL_METHOD_RESPONSE(fl_method_success_response_new(result));
  return fl_method_channel_respond(self->channel, self->response_handle,
                                   response, error);
}