facebook.showDialog()

Overview

Displays an interactive Facebook UI dialog for publishing posts to a user's stream, inviting friends to your app, etc. Use facebook.request() if you need the application itself to do the posting.

The response from the dialog comes back as a fbconnect event that is sent to the listener function which was registered with a call to facebook.login() or facebook.setFBConnectListener().

Syntax

facebook.showDialog( action, params )

Share Dialog

Displays the Facebook dialog for sharing content. For this dialog, action should be either "link" or "photo".

For this dialog, the params table can contain the following key-value pairs. Note that some keys are required while others are not.

• link — Required if action is "link"; string value for a URL for the content being shared.
• peopleIds — Optional table containing the list of IDs for taggable people to tag with this content.
• placeId — Optional string value for the ID for a place to tag with this content.
• ref — Optional string value to be added to the referrer URL when a person follows a link from this shared content on their feed.
• title — Optional if action is "link"; string value for the title to display for this link.
• description — Optional if action is "link"; string value with the description of the link.
• picture — Optional if action is "link"; string value for a URL of a picture to attach to this content.
• photos — Required if action is "photo"; array of Lua tables containing info about the photos to share. Each table inside this array should include a url key with a string value representing a URL for the photo.

Game Request Dialog

Displays a native view which allows the user to send game requests to their choice of friends. For this dialog, action should be "requests".

For this dialog, the params table can contain the following key-value pairs.

• to — String value for the user ID of the person to send this request to.
• title — String value for the title of the dialog.
• message — String value for a message to be sent along with the game request.
• suggestions — Table containing the user IDs of suggested friends for this game request.
• data — String value for additional data to attach to the post.
• objectId — String value for the Open Graph object ID of the object being sent.
• actionType — String value for defining additional context about the nature of the request. By default, no action type is used. Supported actionType values include:
  • "SEND" — The user is sending an object to friends. Requires an objectId to also be provided. Maps to the gifting and social trading scenario.
  • "ASKFOR" — The user is asking for an object from friends. Requires an objectId to also be provided. Maps to the asking for help scenario.
  • "TURN" — It is the turn of the friends to play against the user in a match. An objectId should not be provided in this case. Maps to the turn-based games scenario.
• filter — String value for a filter on who can be displayed in the multi-friend selector. By default, all friends will be displayed in the selector. Supported filter values include:
  • "APP_USERS" — Only friends who use the app will be displayed.
  • "APP_NON_USERS" — Only friends who do not use the app will be displayed. Maps to the invites scenario.

Examples

local facebook = require( "plugin.facebook.v4" )

local function facebookListener( event )

    if ( "session" == event.type ) then
        if ( "login" == event.phase ) then

            local shareParams = {
                link = "https://www.coronalabs.com/",
                title = "Corona Labs"
            }
            facebook.showDialog( "link", shareParams )
        end

    elseif ( "dialog" == event.type ) then
        print( event.response )
    end
end

facebook.login( facebookListener )

local facebook = require( "plugin.facebook.v4" )

local function facebookListener( event )

    if ( "session" == event.type ) then
        if ( "login" == event.phase ) then
        
            facebook.showDialog( "requests", 
                { 
                    message = "You should download this game!",
                    filter = "APP_NON_USERS"
                })
        end

    elseif ( "dialog" == event.type ) then
        print( event.response )
    end
end

facebook.login( facebookListener )