1
0
mirror of https://github.com/node-red/node-red-nodes.git synced 2023-10-10 13:36:58 +02:00
node-red-nodes/social/twitter/27-twitter.html
2018-06-08 12:55:19 +01:00

246 lines
11 KiB
HTML

<script type="text/x-red" data-template-name="twitter-credentials">
<div class="form-row">
<label for="node-config-input-screen_name"><i class="fa fa-twitter"></i> <span data-i18n="twitter.label.twitter-id"></span></label>
<i class="fa fa-at"></i> <input type="text" id="node-config-input-screen_name">
</div>
<div class="form-row">
<p style="margin-top: 30px;"><b>1.</b> <span data-i18n="twitter.label.create"></span> <a href="https://apps.twitter.com/" target="_blank" style="text-decoration:underline;">apps.twitter.com</a></p>
</div>
<div class="form-row">
<p style="margin-top: 30px;"><b>2.</b> <span data-i18n="twitter.label.copy-consumer"></span></p>
</div>
<div class="form-row">
<label style="margin-left: 20px;" for="node-config-input-consumer_key"><span data-i18n="twitter.label.consumer_key"></span></label>
<input type="password" id="node-config-input-consumer_key">
</div>
<div class="form-row">
<label style="margin-left: 20px;" for="node-config-input-consumer_secret"><span data-i18n="twitter.label.consumer_secret"></span></label>
<input type="password" id="node-config-input-consumer_secret">
</div>
<div class="form-row">
<p style="margin-top: 30px;"><b>3.</b> <span data-i18n="twitter.label.copy-accessToken"></span></p>
</div>
<div class="form-row">
<label style="margin-left: 20px;" for="node-config-input-access_token"><span data-i18n="twitter.label.access_key"></span></label>
<input type="password" id="node-config-input-access_token">
</div>
<div class="form-row">
<label style="margin-left: 20px;" for="node-config-input-access_token_secret"><span data-i18n="twitter.label.access_secret"></span></label>
<input type="password" id="node-config-input-access_token_secret">
</div>
</script>
<script type="text/x-red" data-help-name="twitter-credentials">
<p>Authentication for the Twitter API</p>
<p>Earlier versions of this node provided one-click authentication. Twitter removed the ability
to do that in June 2018. You must now register your own application with
<a href="https://apps.twitter.com">Twitter</a> and generate your own access tokens.</p>
</script>
<script type="text/javascript">
(function() {
var twitterConfigNodeId = null;
var twitterConfigNodeIntervalId = null;
RED.nodes.registerType('twitter-credentials',{
category: 'config',
defaults: {
screen_name: {value:""}
},
credentials: {
consumer_key: { type: "password"},
consumer_secret: { type: "password" },
access_token: {type: "password"},
access_token_secret: {type:"password"}
},
label: function() {
if (this.screen_name) {
return (this.screen_name[0]!=="@"?"@":"")+this.screen_name
} else {
return "Twitter: "+this.id
}
},
exportable: false,
oneditsave: function() {
var trimFields = [
"consumer_key",
"consumer_secret",
"access_token",
"access_token_secret"
];
// Just in case any whitespace has crept in with the copy-paste of the fields
trimFields.forEach(function(field) {
var v = $("#node-config-input-"+field).val();
v = v.trim();
$("#node-config-input-"+field).val(v);
});
}
});
})();
</script>
<script type="text/x-red" data-template-name="twitter in">
<div class="form-row">
<label for="node-input-twitter"><i class="fa fa-user"></i> <span data-i18n="twitter.label.twitter-id"></span></label>
<input type="text" id="node-input-twitter">
</div>
<div class="form-row">
<label for="node-input-user"><i class="fa fa-search"></i> <span data-i18n="twitter.label.search"></span></label>
<select type="text" id="node-input-user" style="display: inline-block; vertical-align: middle; width:60%;">
<option value="false" data-i18n="twitter.search.public"></option>
<option value="true" data-i18n="twitter.search.follow"></option>
<option value="user" data-i18n="twitter.search.user"></option>
<option value="dm" data-i18n="twitter.search.direct"></option>
<option value="event" data-i18n="twitter.search.events"></option>
</select>
</div>
<div id="tweet-events-deprecated" class="hide form-tips" style="background: #edd; padding: 20px; margin-bottom: 20px">
<i class="fa fa-warning"></i> Twitter are withdrawing the API used to access a user&apos;s activity stream in August 2018 so this feature will be removed from the node in the near future. See <a href="https://bit.ly/2kr7InE">here</a> for details.
</div>
<div class="form-row" id="node-input-tags-row">
<label for="node-input-tags"><i class="fa fa-tags"></i> <span id="node-input-tags-label" data-i18n="twitter.label.for"></span></label>
<input type="text" id="node-input-tags" data-i18n="[placeholder]twitter.placeholder.for">
</div>
<div class="form-row">
<label for="node-input-name"><i class="fa fa-tag"></i> <span data-i18n="node-red:common.label.name"></span></label>
<input type="text" id="node-input-name" data-i18n="[placeholder]node-red:common.label.name">
</div>
<div class="form-tips"><span data-i18n="[html]twitter.tip"></span></div>
</script>
<script type="text/x-red" data-help-name="twitter in">
<p>Twitter input node. Can be used to search either:
<ul><li>the public stream for tweets containing the configured search term</li>
<li>all the tweets from accounts that the authenticated user follows</li>
<li>all tweets by specified users</li>
<li>direct messages received by the authenticated user</li>
</ul></p>
<p>Use space for <i>and</i> and comma , for <i>or</i> when searching for multiple terms.
If you want to pass in the search term(s) via the <code>msg.payload</code>, leave the <b>for</b> field blank.</p>
<p>Sets the <code>msg.topic</code> to <i>tweets/</i> and then appends the senders screen name.</p>
<p>Sets <code>msg.location</code> to the tweeters location if known.</p>
<p>When returning events it sets the <code>msg.payload</code> to the twitter event, a full list is documented by
<a href="https://dev.twitter.com/streaming/overview/messages-types#Events_event" target="_new">Twitter</a>.</p>
<p>Sets <code>msg.tweet</code> to the full tweet object as documented by <a href="https://dev.twitter.com/overview/api/tweets" target="_new">Twitter</a>.
<p><b>Note</b>: This node is not connected to the FireHose, so will not return 100% of all tweets to a busy @id or #hashtag.</p>
<p><b>Note:</b> when set to follow specific users, or your direct messages, the node is subject to
the rate limiting of the Twitter API. If you deploy the flows multiple times within a 15 minute window, you may
exceed the limit and will see errors from the node. These errors will clear automatically when the current 15
minute window passes.</p>
</script>
<script type="text/javascript">
RED.nodes.registerType('twitter in',{
category: 'social-input',
color:"#C0DEED",
defaults: {
twitter: {type:"twitter-credentials",required:true},
tags: {value:""},
user: {value:"false",required:true},
name: {value:""},
topic: {value:"tweets"},
inputs: {value:0}
},
inputs: 0,
outputs: 1,
icon: "twitter.png",
label: function() {
if (this.name) {
return this.name;
}
var uname = RED.nodes.node(this.twitter);
if (this.user == "dm") {
return (uname?uname.label()+" ":"")+this._("twitter.label.dmslabel");
} else if (this.user == "event") {
var user = RED.nodes.node(this.twitter);
return (user?user.label()+" ":"")+this._("twitter.label.eventslabel");
} else if (this.user == "user") {
return this.tags+" "+this._("twitter.label.tweetslabel");
}
else if (this.user == "true") {
return this._("twitter.label.followers") + (uname?(" "+uname.label()):"");
}
return "twitter";
},
labelStyle: function() {
return this.name?"node_label_italic":"";
},
oneditprepare: function() {
var userlabel = this._("twitter.label.user");
var userph = this._("twitter.placeholder.user");
var forlabel = this._("twitter.label.for");
var forph = this._("twitter.placeholder.for");
$("#node-input-user").change(function() {
var type = $("#node-input-user option:selected").val();
if (type == "user") {
$("#node-input-tags-row").show();
$("#node-input-tags-label").html(userlabel);
$("#node-input-tags").attr("placeholder",userph);
} else if ((type == "dm")||(type == "true")||(type == "event")) {
$("#node-input-tags-row").hide();
} else {
$("#node-input-tags-row").show();
$("#node-input-tags-label").html(forlabel);
$("#node-input-tags").attr("placeholder",forph);
}
$("#tweet-events-deprecated").toggle((type === 'event'));
});
$("#node-input-user").change();
},
oneditsave: function() {
if ($('#node-input-tags').val() === '' && $("#node-input-user option:selected").val() === 'false') {
this.inputs = 1;
}
else {
//set back the default state of 0 inputs
//this.inputs = 0;
}
}
});
</script>
<script type="text/x-red" data-template-name="twitter out">
<div class="form-row">
<label for="node-input-twitter"><i class="fa fa-user"></i> <span data-i18n="twitter.label.twitter-id"></span></label>
<input type="text" id="node-input-twitter">
</div>
<div class="form-row">
<label for="node-input-name"><i class="fa fa-tag"></i> <span data-i18n="node-red:common.label.name"></span></label>
<input type="text" id="node-input-name" data-i18n="[placeholder]node-red:common.label.name">
</div>
</script>
<script type="text/x-red" data-help-name="twitter out">
<p>Twitter out node. Tweets the <code>msg.payload</code>.</p>
<p>To send a Direct Message (DM) - use a payload like "D {username} {message}"</p>
<p>If <code>msg.media</code> exists and is a Buffer object, this node will treat it
as an image and attach it to the tweet.</p>
<p>If <code>msg.params</code> exists and is an object of name:value pairs,
this node will treat it as parameters for the update request.</p>
</script>
<script type="text/javascript">
RED.nodes.registerType('twitter out',{
category: 'social-output',
color:"#C0DEED",
defaults: {
twitter: {type:"twitter-credentials",required:true},
name: {value:"Tweet"}
},
inputs:1,
outputs:0,
icon: "twitter.png",
align: "right",
label: function() {
return this.name;
}
});
</script>