Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Task]: Clarification Needed: Incorrect Listener Creation in ballerinax/trigger.salesforce Documentation #308

Open
PasinduYeshan opened this issue Nov 26, 2023 · 0 comments

Comments

@PasinduYeshan
Copy link

Description

The current documentation in ballerinax/trigger.salesforce suggests the following method for creating a listener:

sfdc:ListenerConfig configuration = {
    username: "USER_NAME",
    password: "PASSWORD" + "SECURITY_TOKEN",
    channelName: "CHANNEL_NAME"
};
listener Listener sfdc:Listener = new (configuration);

However, it appears that there might be an error in the code snippet. The correct way to create a listener should be:

sfdc:ListenerConfig configuration = {
    username: "USER_NAME",
    password: "PASSWORD" + "SECURITY_TOKEN",
    channelName: "CHANNEL_NAME"
};

listener sfdc:Listener sfEventListener = new (configuration);

Please review and confirm if the corrected code is accurate.

Further, certain prerequisites required for this feature might not be available in the free version of Salesforce. However, these prerequisites are accessible in the developer edition. To enhance the documentation and provide users with accurate information, it's recommended to include a note about the availability of these prerequisites in the developer edition. This will guide users to use the appropriate Salesforce edition for enabling the mentioned feature.

Describe your task(s)

  • Code Snippet Correction
  • Prerequisites Clarification

Related area

-> API Docs

Related issue(s) (optional)

No response

Suggested label(s) (optional)

No response

Suggested assignee(s) (optional)

No response

@ballerina-bot ballerina-bot transferred this issue from ballerina-platform/ballerina-lang Nov 26, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant